API Reference

Run the transformation pipeline over an account's exported reports for a date range and return the result. Requires account manager rights.

get
https://platform.routy.app/api/v1/integrations/accounts/exported-reports/transform

Transforms the raw report rows into mapped event data using the account's column mappings. The
startDate must not be later than the endDate, otherwise the request
is rejected. When format is csv the result is returned as a CSV file rather than JSON.

🔐 Required permission: AccountManager

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

The integration account whose reports to transform.

string
enum

The aggregation level to transform by (click, day, tracker, brand or month).

Allowed:
date-time

Start of the date range to transform (inclusive). Must not be later than endDate.

date-time

End of the date range to transform (inclusive).

string

Output format; pass csv to receive a CSV file instead of JSON.

boolean

When true, the raw data table is included in the response; otherwise it is omitted. Defaults to false.

boolean

When true, rows are grouped by dimensions and metrics are summed; null lets the pipeline decide.

boolean

When true (the default when omitted), transformed rows are enriched (e.g. brand/geo lookups).

boolean

When true, the transformed events are persisted; defaults to false (preview only).

boolean

When true, errors are handled gracefully for diagnostics; defaults to false.

boolean

Dry-run mode: previews the transformation without uploading and includes Draft-status columns; defaults to false.

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