API Reference

Returns a paginated list of account tracking profiles matching the supplied search criteria.

get
https://platform.routy.app/api/v1/accounts/tracking-profiles

Requires the AccountsRead policy. Paginate with Offset (0-based) and Limit.

🔐 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. Restricts results to these affiliate ids.

AffiliateId
AccountId
array of int32s

Optional. Restricts results to these Routy internal account ids.

AccountId
TrackerId
array of strings

Optional. Restricts results to these external tracker ids (as presented on the affiliate program).

TrackerId
Id
array of int32s

Optional. Restricts results to these tracking-profile ids. Serialized as ids.

Id
TrafficSourceId
array of int32s

Optional. Restricts results to these mapped traffic-source ids. Serialized as trafficSourceIds.

TrafficSourceId
BrandId
array of int32s

Optional. Restricts results to these mapped brand ids. Serialized as brandIds.

BrandId
CountryCode
array of strings

Optional. Restricts results to these mapped country codes (ISO 3166-1 alpha-2).

CountryCode
RegionCode
array of strings

Optional. Restricts results to these mapped region codes.

RegionCode
CommissionPlanId
array of int32s

Optional. Restricts results to these assigned commission-plan ids.

CommissionPlanId
boolean

Optional. When set, filters by whether a traffic source is (true) or is not (false) mapped.

boolean

Optional. When set, filters by whether a brand is (true) or is not (false) mapped.

boolean

Optional. When set, filters by whether a country code is (true) or is not (false) mapped.

boolean

Optional. When set, filters by whether a region code is (true) or is not (false) mapped.

string

Optional. Free-text search term applied across name-like fields.

date-time

Optional. Restricts results to tracking profiles added on/after this date. Serialized as addedSince.

int32

Optional. Number of items to skip (0-based). Pagination uses Offset/Limit, not page numbers.

int32

Optional. Maximum number of items to return.

string

Optional. Name of the field to sort by. Serialized as sort.

string

Optional. Sort direction: asc (default) 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