API Reference

Get click metadata by search criteria, supplied in the request body.

post
https://platform.routy.app/api/v1/clicks/metadata

Requires the ListAccount policy. Returns a lightweight metadata projection of clicks rather
than full click records. A date range (from/to) is required unless at least one of
clickIds or dparams is supplied; otherwise the request is rejected with 400.
Paginate with offset (0-based) and limit.

🔐 Required permission: SystemAdmin

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Filter, sort and pagination criteria.

Filter, sort and pagination criteria for querying clicks.

affiliateId
array of int32s | null

Optional. Restrict to these affiliate ids.

affiliateId
trafficSourceId
array of int32s | null

Optional. Restrict to these traffic source ids.

trafficSourceId
date-time | null

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

date-time | null

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

accountId
array of int32s | null

Optional. Restrict to these account ids.

accountId
affiliateTrackerId
array of int32s | null

Optional. Restrict to these affiliate tracker ids.

affiliateTrackerId
brandId
array of int32s | null

Optional. Restrict to these brand ids.

brandId
string | null

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

string | null

Optional. Free-text search across click fields.

clickIds
array of uuids | null

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

clickIds
dparams
array of strings | null

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

dparams
int32 | null

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

int32 | null

Optional. Maximum number of items to return.

brandLinkId
array of int32s | null

Optional. Restrict to these brand link ids.

brandLinkId
string | null

Optional. Field name to sort by.

string | null

Optional. Sort direction: asc or desc.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request 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