API Reference

List traffic sources matching the supplied search criteria.

get
https://platform.routy.app/api/v1/traffic-sources

Requires the TrafficSourceRead policy. Paginate with offset (0-based) and limit.
When no criteria are supplied an empty (default) criteria is used. Results are scoped to the
caller's affiliate(s) for non-admin tokens.

🔐 Required permission: traffic-source.read

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

Restrict to these traffic source ids.

Id
int32
deprecated

Single affiliate id filter. Deprecated — use Platform.Models.TrafficSources.TrafficSourceSearchCriteria.AffiliateIds.

AffiliateIds
array of int32s

Restrict to these affiliate ids.

AffiliateIds
string

Filter by exact traffic source key (slug).

int32

Restrict to traffic sources owned by this team.

string

Free-text search term (matched against name/key by the service).

UserIds
array of strings

Restrict to traffic sources owned by these user ids.

UserIds
Statuses
array of objects

Restrict to these statuses (Platform.Models.TrafficSources.TrafficSourceStatus).

Statuses
Allowed:
string
enum

Whether archived sources are included. Defaults to Platform.Models.Archiving.ArchiveFilter.Active
(archived sources hidden from the main list). Archiving does not affect traffic.

Allowed:
int32

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

int32

Maximum number of items to return. Optional.

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