Common Objects

Request

cohort

Defines if cohort logic should be applied to the data.

Field	Value	Description
enabled	bool	Enables or disables cohort grouping. true: group events by cohort (install date) false: group events by day they occurred.
dx	[int]	Controls which days after install (dx) to include in the calculation. No value: Calculates events for all days. [0]: Calculates events on the day of install (d0). [0, 3]: Calculates events on d0 and d3. [0, 1, 2, 3]: Calculates events on d0, d1, d2, and d3.

interval

Defines the date range which should be queried.

Field	Value
from	string	"YYYY-mm-dd" format. Data starting on this day will be included.
until	string	"YYYY-mm-dd" format. Data until this date (inclusive) will be included.

pagination

Specifies the request pagination frame.

Field	Value
page	int	The page which should be returned. Set 0 to get the very first page.
limit	int	Amount of rows to return in the response.

orderBy

Defines the sorting order for the results.

You can order only by dimension or metrics which are specified in corresponding section.

Field	Value
name	string	Name of the metric or dimension to sort by.
order	string	Can be desc or asc

filters

Allows to filter the data by dimensions.

The filter is written as an object where each key is a dimension and the value is a the selection of the requested dimension values. Values within one dimension have an or relation and dimensions within filters have an and relation.

For example, if one wants to get results only for the app dimension and your app store id is my.awesome.app, the filter will look like:

"filters": {
    "app": ["my.awesome.app"],
}

Available filters:

• app

granularity

Specifies how the time interval should be grouped. Available options:

• day

• week

• month

Response

pagination

Specifies the response pagination frame.

Field	Value
total	int	Total amount of data rows available.
page	int	The number of the returned page.
limit	int	Number of rows on this page.

row

Row represents one row in the table. The keys will be the requested dimensions and metrics.

For example, if you filter the data for the app dimension with the value my.awesome.app, and request the metric clicks, your row will look like:

{
   "app": "my.awesome.app",
   "clicks": 830345
}

sum

Contains the summarized values of the requested metrics. Not only from the current page but from the whole time interval.

<date>

Can be in different formats depending on the requested granularity.

granularity in the request	key format in the response
day	YYYY-mm-dd
week	YYYY-ww
month	YYYY-mm

<metric>

Is a requested metric.

For example, if one requests the metrics clicks and averageRevenuePerInstall with the granularity day, the response will look like:

{
   "2022-02-02": {
       "clicks": 100,
       "averageRevenuePerInstall": 3,5356
   }
}