API Reference

Conversion performance report.

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

Joins clicks with their conversions over the requested conversion date range, groups by the
requested fields dimensions and returns the summed stats metrics per group.

Results are scoped to the calling affiliate; admin tokens see all affiliates.
The response payload is a ReportResponse with columns, data,
resultCount and totalCount. With the default responseType=table each
row is an ordered array aligned to columns; with responseType=json each row is
a keyed object.

Example: GET /v1/reports/events/performance?fields=brand_name&stats=ftd&conversionDateFrom=2026-05-01&conversionDateTo=2026-05-20&limit=100

🔐 Required permission: accounts.read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
Fields
array of strings
required
length ≥ 1

Grouping dimensions for the report (the report's GROUP BY). At least one is required.
Allowed values: affiliate_program_id, affiliate_program_name,
brand_id, brand_name, brand_link_id, brand_link_name,
affiliate_program_account_id, affiliate_program_account_name,
traffic_source_id, traffic_source_name, affiliate_tracker_id,
affiliate_tracker_name, country_code, country,
conversion_time, conversion_currency_code, server_time,
created_at, parameter_a, parameter_b, external_click_id,
dynamic_parameter, device_os, device_name, region,
timezone, ipcity, ipcontinent.

Fields*
Stats
array of strings
required
length ≥ 1

Conversion metrics to sum per group. At least one is required. Each value is the
name (or friendly name) of a conversion type configured for the account
(e.g. ftd, deposits, registrations). Matching is case-insensitive.

Stats*
date-time
required

Inclusive start of the conversion date range (UTC). Required.

date-time
required

Inclusive end of the conversion date range (UTC). Required and must be on or after
Platform.Models.Reporting.Performance.PerformanceReportRequest.ConversionDateFrom.

date-time

Optional inclusive start of the click date range (UTC). When set together with
Platform.Models.Reporting.Performance.PerformanceReportRequest.ClickDateTo the underlying clicks are additionally filtered by click date.

date-time

Optional inclusive end of the click date range (UTC).

TrafficSourceIds
array of int32s

Optional filter: only include clicks from these traffic source ids.

TrafficSourceIds
AccountIds
array of int32s

Optional filter: only include clicks sent to these account (affiliate program account) ids.

AccountIds
BrandIds
array of int32s

Optional filter: only include clicks for these brand ids.

BrandIds
string

Optional column to sort by. Must be one of the requested Platform.Models.Reporting.Performance.PerformanceReportRequest.Fields or
Platform.Models.Reporting.Performance.PerformanceReportRequest.Stats values. Defaults to the requested fields when omitted.

string
Defaults to asc

Sort direction: asc (default) or desc.

int32
0 to 2147483647

Number of rows to skip for pagination (0-based). Defaults to 0.

int32
1 to 999

Maximum number of rows to return. Defaults to 100; must be less than 1000.

string
enum
Defaults to Table

Shape of the returned data: table (default — rows as ordered value arrays with a
separate columns list, suited for tabular/CSV rendering) or json
(rows as keyed objects).

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