Skip to main content

API Specification

Metrics API (1.21.0)

Download OpenAPI specification:Download

Metrics API

metrics

new_users

The count of users who were new on the specified time interval

Returns new_users metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

new_users metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

returning_users

The count of users who showed up again X days after installing the game.

Data is requested with daily granularity.

Returns returning_users metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

returning_users metrics

One of
ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

game
required
string (GameId)

Game ID

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
since_days_ago
required
integer (SinceDaysAgo) [ 1 .. 90 ]

Look at this many days ago

Responses

Request samples

Content type
application/json
Example
{
  • "filter": {
    },
  • "game": "2923",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "since_days_ago": 14
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

session_length_per_user

Playtime. The amount of time spent within the app.

Returns session_length_per_user metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

session_length_per_user metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

ilrd_count_per_dau

Impression level revenue data: revenue per daily active user from ad network providers(e.g. MoPub).

Returns ilrd_count_per_dau metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

ilrd_count_per_dau metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

ilrd_revenue_per_session

Impression level revenue data: revenue per session from ad network providers(e.g. MoPub).

Returns ilrd_revenue_per_session metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

ilrd_revenue_per_session metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

arppu

Average revenue per paying user

Returns arppu metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

arppu metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

ad_impressions_per_session

Average number of times Ads were shown in your game per unique session over the specified time interval.

Returns ad_impressions_per_session metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

ad_impressions_per_session metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

conversion_ft

The percent of users who made their first purchase on the specified time interval

Returns conversion_ft metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

conversion_ft metrics

One of
ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

game
required
string (GameId)

Game ID

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)

Responses

Request samples

Content type
application/json
Example
{
  • "filter": {
    },
  • "game": "2923",
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    }
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

converting_users

1st time paying users

Returns converting_users metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

converting_users metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

Supported metrics

List of available metrics to query.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • "arpu",
  • "arppu",
  • "conversion",
  • "conversion_ft",
  • "converting_users",
  • "event_count",
  • "installs_ratio",
  • "new_users",
  • "paying_users",
  • "retention_ahead",
  • "retention_retro",
  • "retention_count",
  • "returning_users",
  • "revenue",
  • "session_length",
  • "session_length_per_user",
  • "sessions_per_user",
  • "session_unique",
  • "user_unique",
  • "ilrd_revenue",
  • "ilrd_revenue_per_session",
  • "ilrd_arpu",
  • "ilrd_revenue_per_dau",
  • "ilrd_count_per_dau",
  • "ad_impressions_count",
  • "ad_impressions_per_user",
  • "ad_impressions_per_session"
]

session_unique

The count of sessions played on the specified time interval

Returns session_unique metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

session_unique metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

retention_retro

The percent of users who showed up again X days after installing the game.

Data is requested with daily granularity.

Returns retention_retro metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

retention_retro metrics

One of
ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

game
required
string (GameId)

Game ID

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
SplitQuery (object) or RetentionRetroTimeseriesQuery (object)
since_days_ago
required
integer (SinceDaysAgo) [ 1 .. 90 ]

Look at this many days ago

Responses

Request samples

Content type
application/json
Example
{
  • "filter": {
    },
  • "game": "2923",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "since_days_ago": 14
}

Response samples

Content type
application/json
{
  • "result": [
    ]
}

sessions_per_user

The count of sessions per user

Returns sessions_per_user metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

sessions_per_user metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

retention_count

The count of users who showed up again X days after installing the game.

Data is requested with daily granularity.

Returns retention_count metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

retention_count metrics

One of
days_ahead
required
integer (DaysAhead) [ 1 .. 90 ]

Look at this many days forward

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

game
required
string (GameId)

Game ID

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)

Responses

Request samples

Content type
application/json
Example
{
  • "days_ahead": 14,
  • "filter": {
    },
  • "game": "2923",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    }
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

event_count

Event count

Returns event_count metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

event_count metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

ad_impressions_count

Number of times Ads were shown in your game over the specified time interval. This data is taken from Ad events: events with a category "ads", where "ad_action" is "show".

Returns ad_impressions_count metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

ad_impressions_count metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

ad_impressions_per_user

Average number of times Ads were shown in your game per unique user over the specified time interval.

Returns ad_impressions_per_user metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

ad_impressions_per_user metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

ilrd_revenue

Impression level revenue data: revenue from ad network providers (e.g. MoPub).

Returns ilrd_revenue metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

ilrd_revenue metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

user_unique

The count of users played on the specified time interval

Returns user_unique metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

user_unique metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

retention_ahead

The percent of users who showed up again X days after installing the game.

Data is requested with daily granularity.

Returns retention_ahead metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

retention_ahead metrics

One of
days_ahead
required
integer (DaysAhead) [ 1 .. 90 ]

Look at this many days forward

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

game
required
string (GameId)

Game ID

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
SplitQuery (object) or RetentionAheadTimeseriesQuery (object)

Responses

Request samples

Content type
application/json
Example
{
  • "days_ahead": 14,
  • "filter": {
    },
  • "game": "2923",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    }
}

Response samples

Content type
application/json
{
  • "result": [
    ]
}

installs_ratio

The percent of users who were new on the specified time interval

Returns installs_ratio metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

installs_ratio metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

arpu

Average revenue per user. Using different granularity allows you to achieve ARPDAU, ARPWAU or ARPMAU.

Returns arpu metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

arpu metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

ilrd_arpu

Impression level revenue data: revenue sum per user reported by ad network providers (e.g. MoPub).

Returns ilrd_arpu metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

ilrd_arpu metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

paying_users

The count of your users who spent money on the specified time interval

Returns paying_users metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

paying_users metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

revenue

The sum of all transaction amounts made in the specified time interval

Returns revenue metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

revenue metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

conversion

The percent of users who made a purchase for the specified time interval

Returns conversion metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

conversion metrics

One of
ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

game
required
string (GameId)

Game ID

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)

Responses

Request samples

Content type
application/json
Example
{
  • "filter": {
    },
  • "game": "2923",
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    }
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

ilrd_revenue_per_dau

Impression level revenue data: revenue per daily active user from ad network providers(e.g. MoPub).

Returns ilrd_revenue_per_dau metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

ilrd_revenue_per_dau metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

session_length

The amount of time that has passed between when the user starts the app, and when it is sent to background

Returns session_length metrics matching the provided request.

Authorizations:
api_key
Request Body schema: application/json
required

session_length metrics

ANDFilter (object) or ORFilter (object) or NOTFilter (object) or NameFilter (object) (DimensionFilter)

Dimension filter

games
Array of strings (GameIdList)

List of game IDs

granularity
required
string (Granularity)
Enum: "day" "week" "month" "all"

Metric request granularity

interval
required
string (Interval)

ISO-8601 interval (UTC) that covers the earliest and latest data points of a data set.

Please note that interval can't be larger than 31 days for requests with day granularity.

required
GroupQuery (object) or SplitQuery (object) or TimeseriesQuery (object) (QueryType)
studios
Array of strings (StudioIdList)

List of studio IDs

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "games": [
    ],
  • "granularity": "day",
  • "interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
  • "query": {
    },
  • "studios": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": [
    ]
}

dimensions

Supported dimensions

Returns list of supported dimensions.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • "game_id",
  • "build",
  • "first_build",
  • "category",
  • "country_code",
  • "platform",
  • "installed_on",
  • "is_paying",
  • "is_converting",
  • "ad_sdk_name",
  • "ad_type",
  • "ad_action",
  • "ilrd_sdk_vendor",
  • "ilrd_adunit_name",
  • "ilrd_network_name",
  • "ilrd_adunit_format",
  • "install_publisher",
  • "ab_id",
  • "ab_variant_id",
  • "severity"
]

Dimension values

Returns list of possible values for a specified dimension that are present for the given interval

Authorizations:
api_key
path Parameters
dimension
required
string (DimensionName)
Enum: "game_id" "build" "first_build" "category" "country_code" "platform" "installed_on" "is_paying" "is_converting" "ad_sdk_name" "ad_type" "ad_action" "ilrd_sdk_vendor" "ilrd_adunit_name" "ilrd_network_name" "ilrd_adunit_format" "install_publisher" "ab_id" "ab_variant_id" "severity"
Example: platform

Dimension to fetch available values for

query Parameters
interval
required
string (Interval)
Example: interval=2012-01-01T00:00:00.000/2012-01-03T00:00:00.000

The interval to fetch available dimensions for

Array of StudioIdList (strings) or StudioId (string) (StudioFilter)

Studio or a list of studios to filter on, only dimensions within the provided studios will be returned

Array of GameIdList (strings) or GameId (string) (GameFilter)

Game or a list of games to filter on, only dimensions within the provided games will be returned

limit
integer (Limit) [ 1 .. 30000 ]
Default: 100
Example: limit=100

Total number of values to return

Responses

Response samples

Content type
application/json
{
  • "dimension": "platform",
  • "values": [
    ]
}

games

List of games

Returns list of games available to query over a specified interval. Response is limited to a list of games events of which can be found in the specified time interval. Games with no activities for the provided interval won't be present in the response.

Authorizations:
api_key
query Parameters
interval
required
string (Interval)
Example: interval=2012-01-01T00:00:00.000/2012-01-03T00:00:00.000

The interval to fetch available games for

Array of StudioIdList (strings) or StudioId (string) (StudioFilter)

Studio or a list of studios to filter on, only games within those studios will be returned

limit
integer (Limit) [ 1 .. 30000 ]
Default: 100
Example: limit=100

Total number of games to return

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

interval

Time boundaries.

Returns an ISO-8601 interval (UTC) with the time period for data availability. This is used for example to retrieve the time when the data becomes available for the last day.

Responses with 204 HTTP code and empty body if there are no data available for the authorized organization.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
"2012-01-01T00:00:00.000/2012-01-03T00:00:00.000"

studios

List studios

List of available studios for the interval. Response is limited to a list of studios with games events of which can be found in the specified time interval. Studios without any game activities the provided interval won't be present in the response.

Authorizations:
api_key
query Parameters
interval
required
string (Interval)
Example: interval=2012-01-01T00:00:00.000/2012-01-03T00:00:00.000

The interval to fetch available studios for

limit
integer (Limit) [ 1 .. 30000 ]
Default: 100
Example: limit=100

Total number of studios to return

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]