Report Data

post

https://api.kayzen.io/v1/report_data

Body Params

advertiser_id

int32

Advertiser ID.
Required for the roles - Advertiser admin, Account Manager and Analyst.
Enterprise admin users use filters, e.g. "filters": {"advertiser_id": [108993,108994]}

start_date

date

required

Start Date of Report, e.g.: 2025-01-30

end_date

date

required

End Date of Report, inclusive, e.g.: 2025-01-30

page

int32

Page

per_page

int32

Per Page

time_zone

string

Time zone name, e.g., UTC

without_empty_rows

boolean

Filter out rows where all metrics are zero

sort_field

object

sort_direction

string

enum

Sort in ascending or descending order

Allowed:

filters

json

JSON object with filters.
Please refer to Supported Parameters.
For example: {"campaign_id": [108993,108994]}

metrics

array of strings

required

In-App Events are considered metrics.
Please refer to Supported Parameters

metrics*

cohort_days

array of strings

Cohort day dimensions.
Required when requesting cohort metrics.
Possible values for cohort_days are: 0, 1, 3, 7, 14, 30

cohort_days

cohort_user_segments

array of strings

Cohort user segment.
Required when requesting cohort metrics
Possible values:
- "ua"
- "rt"

cohort_user_segments

attribution_sources

array of strings

Attribution sources, required when requesting attributed metrics.
Possible values: mmp, self, assisted, skan

attribution_sources

attribution_types

array of strings

Attribution types, required when requesting attributed metrics.
Possible values: click, view, total

attribution_types

group_by

array of strings

Dimensions to group by
Please refer to Supported Parameters

group_by

start_date_previous

date

Start Date of the time interval to compare to

end_date_previous

date

End Date of the time interval to compare to

Responses

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400