API Reference

Searches affiliate-account-link composites with inline metrics, accepting the criteria in the request body.

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

Functionally identical to GET /composites/accounts/links/metrics but takes the
AffiliateAccountLinkMetricCompositeRequest as a JSON body. Scoped to the calling affiliate;
admin tokens see all affiliates. Requires the ListAccount policy.

šŸ” Required permission: accounts.read

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

Filtering, sorting, pagination and metric-window criteria.

Criteria for listing/searching affiliate-account-link composites with inline metrics.
Extends Platform.Models.Composite.AffiliateAccountLinkCompositeRequest (all the same filters) and adds the
metric date windows and the display currency.

Platform.Models.Composite.AffiliateAccountLinkCompositeRequest.SortBy additionally accepts the metric keys
clicks, signups, firstTimeDeposit, qualifiers, cpaCommission,
revShareCommission and commission (aggregated over the primary window); a metric key
sorts descending by default, or ascending when prefixed with + (e.g. +clicks).

id
array of int32s | null

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

id
accountId
array of int32s | null

Optional list of account IDs to filter by.

accountId
affiliateProgramId
array of int32s | null

Optional list of affiliate-program IDs to filter by.

affiliateProgramId
softwareId
array of int32s | null

Optional list of tracking-software IDs to filter by.

softwareId
brandId
array of int32s | null

Optional list of brand IDs to filter by.

brandId
commissionPlanId
array of int32s | null

Optional list of commission-plan IDs to filter by.

commissionPlanId
type
array of objects | null

Optional list of brand-link types to filter by.

type
Allowed:
status
array of objects | null

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 | null

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

int32 | null

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

int32 | null

Maximum number of records to return for pagination.

string | null

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.

date-time | null

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

date-time | null

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

date-time | null

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

date-time | null

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

string | null

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

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 months ago

Did this page help you?
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 months ago

Did this page help you?