Skip to main content
GET
List clicks

Authorizations

Authorization
string
header
required

Tolt API key sent as a bearer token.

Query Parameters

limit
integer
default:10

How many rows to return in one page.

Required range: 1 <= x <= 100
order
enum<string>
default:desc

Ranking direction: desc puts the most recently created or updated rows first.

Available options:
asc,
desc
sort
enum<string>
default:created_at

Timestamp to order and page by: created_at follows creation order, updated_at follows each item's most recent change.

Available options:
created_at,
updated_at
starting_after
string

Continue after a position: the next_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with ending_before.

ending_before
string

Page backward from a position: the prev_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with starting_after.

created_after
string<date-time>

Start of a window on when items were created: items created at this time or later are included, for example 2026-01-01T00:00:00Z. Leave it out for no lower bound.

created_before
string<date-time>

End of a window on when items were created: only items created before this time are included. Leave it out for no upper bound.

updated_after
string<date-time>

Only items last changed at or after this moment; with sort=updated_at, use it to fetch what changed since a previous sync.

updated_before
string<date-time>

Only items last changed before this moment; pair it with updated_after to fetch what changed in a period.

program_id
string

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

partner_id
string

Limit to one partner, by its id (part_...) as returned when listing partners.

Limit to one referral link, by its id (lnk_...) as returned when listing links.

country
string

Filter by the click's stored country, matched exactly (values are not normalized). Clicks recorded by the tracking script store a country name (e.g. Canada); clicks created through the API store a 2-letter ISO code (e.g. CA). Filter by the exact form you expect.

Minimum string length: 1
Example:

"Canada"

device
string

Device type, e.g. desktop, mobile or tablet.

Minimum string length: 1
Example:

"desktop"

Response

A page of clicks

success
boolean
required
Example:

true

message
string
required
Example:

"Request successful"

data
object[]
required
has_more
boolean
required
Example:

false

next_cursor
string | null
required

Opaque cursor marking the last item on this page. Pass it as starting_after to continue. Null when the page is empty.

prev_cursor
string | null
required

Opaque cursor marking the first item on this page. Pass it as ending_before to page backward. Null when the page is empty.