Skip to main content
GET
Per-link performance breakdown

Authorizations

Authorization
string
header
required

Tolt API key sent as a bearer token.

Query Parameters

program_id
string

Limit to one program, by its id (prg_...) as returned when listing programs.

start_date
string<date>

Earliest day to include, by creation date (customers by the day they became active). Leave it out for no lower bound.

end_date
string<date>

Latest day to include, by creation date (customers by the day they became active); the whole day counts. Leave it out for no upper bound.

currency
string

Only include transactions and commissions in this currency, such as USD; matching ignores case. Rows without their own currency use their program's.

Minimum string length: 1
limit
integer
default:10

How many rows to return in one page.

Required range: 1 <= x <= 100
offset
integer | null
default:0

How many rows to skip before this page begins.

Required range: 0 <= x <= 10000
sort
enum<string>
default:revenue

Metric to rank by, computed over the date window.

Available options:
revenue,
commissions,
clicks,
customers
order
enum<string>
default:desc

Ranking direction: desc puts the highest values first.

Available options:
asc,
desc

Response

A page of link breakdown rows

success
boolean
required
Example:

true

message
string
required
Example:

"Request successful"

data
object[]
required
has_more
boolean
required
Example:

false