Report Results CSV

get

https://api.kayzen.io/v1/reports/{id}/report_results/download

Submits a CSV URL request for a given Report

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Report ID

Query Params

sort_field[column]

string

Sort by column. Required when sorting

sort_field[source]

string

Attribution source of the column to sort by when it's an attributed metric. Required when sorting

sort_field[type]

string

Attribution type of the column to sort by when it's an attributed metric. Required when sorting

sort_direction

string

Sort result in ascending (asc) or descending (desc) order. Required when sorting

date_macro

string

Select specific day or range of days.
Optional.
The report's date macro will be used if left blank
Possible values: today, yesterday, last_three_days, last_seven_days, this_month, last_three_days_with_today, last_seven_days_with_today, this_month_with_today, last_month, last_30_days

start_date

date

Start date of report, e.g.: 2025-06-21.
Optional.
Will be ignored if you send date_macro

end_date

date

End date of report, e.g.: 2025-06-25.
Optional.
This is ignored in case of use of date_macro

filters

string

JSON object with filters.
Optional.
The report's filters will be used if left blank.
Please refer to Supported Parameters.
For example: {"campaign_id": [108993,108994]}

metrics[]

array of strings

Array of supported metrics.
In-App Events are considered metrics.
The report's metrics will be used if left blank.
Please refer to Supported Parameters

metrics[]

cohort_days[]

array of int32s

Cohort day dimensions.
Optional.
The report's cohort days will be used if left blank.
Required if cohort metrics are selected.
Possible values for cohort_days are: 0, 1, 3, 7, 14, 30

cohort_days[]

cohort_user_segments[]

array of strings

Cohort user segment.
Optional.
The report's cohort user segments will be used if left blank.
Required if cohort metrics are selected
Possible values:
- "ua"
- "rt"

cohort_user_segments[]

attribution_sources[]

array of strings

Sources for attributed metrics.
Optional.
The report's attribution sources will be used if left blank.
Possible values: mmp, self, assisted, skan

attribution_sources[]

attribution_types[]

string

Types for attributed metrics.
Optional.
The report's attribution types will be used if left blank.
Possible values: click, view, total

Responses

200

400Bad Request

500Internal Server Error