API Reference

Retrieves a paginated list of traffic-source composites matching the supplied filters.

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

Each row is a TrafficSourceComposite joining the traffic source with its affiliate, partner,
custom domain, heartbeat and webhook/cloaked-link counts. Filter by id, affiliate, key, free-text
term and status. Paginate with offset (0-based) and limit. Requires the
ListTrafficSources policy.

🔐 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

Optional list of traffic-source IDs to restrict the result to.

Id
AffiliateId
array of int32s

Optional list of affiliate IDs whose traffic sources are returned.

AffiliateId
string

Optional exact match on a traffic source's unique key.

string

Optional free-text term matched (case-insensitively) against traffic-source name/key.

Statuses
array of objects

Optional list of statuses to filter by.

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:
string

Optional sort expression (e.g. field name, optionally with a direction prefix).

int32

Zero-based number of records to skip for pagination. Defaults to 0 when omitted.

int32

Maximum number of records to return for pagination.

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