API Reference

Conversion events report.

get
https://platform.routy.app/api/v1/reports/events/conversions

Returns one row per conversion, decorated with its originating click, matching the supplied
filters. Results are scoped to the calling affiliate; admin tokens see all affiliates.

Paginate either with offset/limit (limit capped at 200) or — when no sortBy
is given — with keyset pagination: results come back ordered by conversion date descending and
the response carries a nextCursor ({ conversionDate, conversionId }) to pass
back as cursorDate/cursorId for the next page. Set countTotal=true on the
first page to populate total.

Example: GET /v1/reports/events/conversions?from=2026-05-01&to=2026-05-20&conversionTypeId=3&sortBy=-conversionDate&limit=100

🔐 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

Filter by affiliate id(s). Ignored for non-admin callers (always their own).

AffiliateId
TrafficSourceId
array of int32s

Filter by traffic source id(s).

TrafficSourceId
date-time

Inclusive lower bound on the conversion timestamp (UTC).

date-time

Inclusive upper bound on the conversion timestamp (UTC). Must be ≥ Platform.Models.Reporting.Events.Conversions.ConversionReportFilter.From.

date-time

Inclusive lower bound on the originating click date (UTC).

date-time

Inclusive upper bound on the originating click date (UTC). Must be ≥ Platform.Models.Reporting.Events.Conversions.ConversionReportFilter.ClickFrom.

AccountId
array of int32s

Filter by account (affiliate program account) id(s).

AccountId
AffiliateTrackerId
array of int32s

Filter by affiliate tracker id(s).

AffiliateTrackerId
BrandId
array of int32s

Filter by brand id(s).

BrandId
CountryCode
array of strings

Filter by ISO country code(s) of the click IP.

CountryCode
ClickId
array of uuids

Return only conversions for these click id(s). When set, other filters are ignored.

ClickId
Dparam
array of strings

Filter by dynamic parameter value(s). Matched case-insensitively (upper-cased server-side).

Dparam
SoftwareId
array of int32s

Filter by affiliate program software id(s).

SoftwareId
BrandLinkId
array of int32s

Filter by brand link id(s).

BrandLinkId
Device
array of strings

Filter by device name(s) (e.g. desktop, smartphone).

Device
OperationSystem
array of strings

Filter by operating system name(s).

OperationSystem
ConversionTypeId
array of int32s

Filter by conversion type id(s).

ConversionTypeId
string

Filter by how the conversion was recorded: Postback (incoming postback) or
Integration (everything else). Other values are ignored.

int32

Rows to skip for offset pagination (0-based). Capped at 1000. Ignored when a cursor is supplied.

int32

Maximum rows to return. Defaults to 100 and is capped at 200.

string

Comma-separated sort fields, each prefixed with + (ascending) or - (descending),
e.g. -conversionDate,+value. The prefix goes before the field name. Field names are any
column of the response row (e.g. conversionDate, value, brand, country).
When omitted, results use keyset pagination ordered by conversion date descending and the
response includes a nextCursor.

string

Free-text search. A valid GUID is treated as a click id; otherwise matched against the dynamic parameter.

boolean

When true, include the total matching row count in total (only on the first/offset-0 page).

date-time

Cursor for keyset pagination - the ConversionDate of the last item from the previous page.
Used only with default sort (ConversionDate DESC). When set, Offset is ignored.

int64

Cursor for keyset pagination - the ConversionId of the last item from the previous page.
Required together with CursorDate for tiebreaking.

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