API Reference

Retrieves a paginated list of affiliate-account-link composites <b>with aggregated metrics inline</b>.

get
https://platform.routy.app/api/v1/composites/accounts/links/metrics

Same filters, paging and link-field sorts as GET /composites/accounts/links, plus per-link
click/conversion metrics for a primary date window (metricsFrom/metricsTo, default last
30 days) and an optional comparison window (comparisonFrom/comparisonTo) for a trend
delta. sortBy additionally accepts clicks, signups, firstTimeDeposit,
qualifiers, cpaCommission, revShareCommission and commission (aggregated
over the primary window; default descending).
Monetary values are returned in currencyCode (defaults to the affiliate's currency, else USD).
A link with no events yields an all-zero metrics block. Scoped to the calling affiliate; admin tokens
see all affiliates. Requires the ListAccount policy. This is the query-string variant of
POST /composites/accounts/links/metrics/search.

🔐 Required permission: accounts.read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date-time

Start of the primary metric window (inclusive, UTC date). Defaults to 30 days before Platform.Models.Composite.AffiliateAccountLinkMetricCompositeRequest.MetricsTo.

date-time

End of the primary metric window (inclusive, UTC date). Defaults to today (UTC).

date-time

Start of the optional comparison window (inclusive, UTC date). When both comparison bounds are set, comparisonMetrics is returned.

date-time

End of the optional comparison window (inclusive, UTC date).

string

The currency the monetary metrics are returned in. Defaults to the affiliate's currency, falling back to USD.

Id
array of int32s

Optional list of brand-link IDs to restrict the result to.

Id
AccountId
array of int32s

Optional list of account IDs to filter by.

AccountId
AffiliateProgramId
array of int32s

Optional list of affiliate-program IDs to filter by.

AffiliateProgramId
SoftwareId
array of int32s

Optional list of tracking-software IDs to filter by.

SoftwareId
BrandId
array of int32s

Optional list of brand IDs to filter by.

BrandId
CommissionPlanId
array of int32s

Optional list of commission-plan IDs to filter by.

CommissionPlanId
Type
array of objects

Optional list of brand-link types to filter by.

Type
Allowed:
Status
array of objects

Optional list of brand-link statuses to filter by.

Status
Allowed:
string
enum

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

Allowed:
string

Optional free-text term matched (case-insensitively) against the link name/URL.

int32

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

int32

Maximum number of records to return for pagination.

string

Optional sort expression: a comma-separated list of fields, each prefixed with
+ for ascending or - for descending (e.g. -name,+id). A field
with no prefix sorts ascending.

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