Create Cohort Report

⚠️

Important

All API V2 tokens generated before March 10, 2026, 19:00 UTC have been revoked. If your token was generated before this date, please regenerate it. Learn how.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

App ID of the app for which you get the report

Body Params

Body for create report request

string
enum
required
  • unified combines the performance of user acquisition and retargeting campaigns.
  • If an event is attributed to both retargeting and user acquisition campaigns, only the retargeting event is included in KPIs returned, meaning is_primary=true.
Allowed:
string
required

Lower bound of the LTV attribution date range. The earliest date supported is 720 days before the current date.
Hour is used when granularity=hour

string
required

Higher bound of the LTV attribution date range.
For a single day: from and to values are identical. Hour is used when granularity=hour`

kpis
array of strings
required
length between 1 and 1
kpis*
string
enum
required
Allowed:
groupings
array of strings
required
length between 1 and 7
groupings*
integer
≥ 1

Minimum cohort size is used to reduce the number of records returned by excluding cohorts having few users. This means that the users KPI has a value equal or greater to that specified.
Default: 1

string
enum

Hourly granularity for the previous 72 hours by setting granularity=hour and setting the from and to range to include the time of day.

Allowed:
boolean

To avoid data distortion and misinterpretation Cohort returns data of complete days. However, the data of partial days can be useful.
The number of complete cohort days for a query is calculated as the difference between today's date and the to date.
Default If false, complete days return.
If true, up to 180 cohort days return, including days having incomplete data.
Example: On May 10, the number of complete cohort days for users converting during April 1-30, is 10.
If false [default], cohort days 0-9, return. This is the number of days (10) between the last conversion date and today.
If true, cohort days 1-40 return. Days 11-40 contain partial data and do not return. For example, since April 20, only 20 days have elapsed, and so on.
Note: Partial data is only allowed when the aggregation type is cumulative.

filters
object
boolean
  • If true, revenue is returned using the app-specific currency set in the platform.
  • Default If false, results return in USD.
boolean
  • If true, times are expressed using the app-specific time zone set in the platform.
  • Default If false, times are expressed using UTC time zone.
boolean

Divide the KPI function by the number of app users. Applies only to relevant KPIs.

  • If true, KPI values are divided by the number of users in the cohort.
  • If false, KPI values are not divided by the number of users.
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json