API Reference

Search clicks (live, unsaved) by criteria.

get
https://platform.routy.app/api/v1/clicks

Requires the ListAccount policy. Results are scoped to the caller's accessible accounts;
admin tokens may see all. Paginate with offset (0-based) and limit. Sort with
sortBy plus sortDirection (asc/desc). Date range is filtered by
from/to.

🔐 Required permission: accounts.read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
AffiliateId
array of int32s

Optional. Restrict to these affiliate ids.

AffiliateId
TrafficSourceId
array of int32s

Optional. Restrict to these traffic source ids.

TrafficSourceId
date-time

Optional. Inclusive lower bound of the click date range (UTC).

date-time

Optional. Inclusive upper bound of the click date range (UTC).

AccountId
array of int32s

Optional. Restrict to these account ids.

AccountId
AffiliateTrackerId
array of int32s

Optional. Restrict to these affiliate tracker ids.

AffiliateTrackerId
BrandId
array of int32s

Optional. Restrict to these brand ids.

BrandId
string

Optional. ISO 3166-1 alpha-2 country code filter.

string

Optional. Free-text search across click fields.

ClickId
array of uuids

Optional. Restrict to these click ids. Serialized as clickIds in JSON.

ClickId
Dparam
array of strings

Optional. Restrict to these dynamic parameters (d-params). Serialized as dparams in JSON.

Dparam
int32

Optional. Number of items to skip (0-based offset). Defaults to 0 when omitted.

int32

Optional. Maximum number of items to return.

BrandLinkId
array of int32s

Optional. Restrict to these brand link ids.

BrandLinkId
string

Optional. Field name to sort by.

string

Optional. Sort direction: asc or desc.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago