Metrics API (1.21.7)

Download OpenAPI specification:Download

Metrics API

metrics

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

AdImpressionsPerSessionGroupQueryResult

{"result": [{"result": [{"ad_impressions_count": 59984,
"ad_impressions_per_session": 9997.333333333334,
"country_code": "KR",
"session_unique": 6
},
{"ad_impressions_count": 16536,
"ad_impressions_per_session": 8268,
"country_code": "SV",
"session_unique": 2
}
],
"timestamp": "2020-12-01T00:00:00.000Z"
},
{"result": [{"ad_impressions_count": 57315,
"ad_impressions_per_session": 3371.470588235294,
"country_code": "KR",
"session_unique": 17
},
{"ad_impressions_count": 16924,
"ad_impressions_per_session": 2417.714285714286,
"country_code": "IE",
"session_unique": 7
}
],
"timestamp": "2020-12-02T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

ConvertingUsersGroupQueryResult

{"result": [{"result": [{"converting_users": 7374,
"country_code": "US"
},
{"converting_users": 1122,
"country_code": "DE"
},
{"converting_users": 797,
"country_code": "GB"
}
],
"timestamp": "2020-05-01T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

SessionUniqueGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"session_unique": 68628741
},
{"country_code": "IN",
"session_unique": 35416211
},
{"country_code": "CN",
"session_unique": 17716756
}
],
"timestamp": "2020-04-27T00:00:00.000Z"
},
{"result": [{"country_code": "US",
"session_unique": 150024236
},
{"country_code": "IN",
"session_unique": 80003576
},
{"country_code": "CN",
"session_unique": 38386893
}
],
"timestamp": "2020-05-04T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

IlrdArpuGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"ilrd_arpu": 0.1564894566666667,
"total_revenue_cents": 46.94683700000001,
"users": 3
},
{"country_code": "FR",
"ilrd_arpu": 0.058624912999999994,
"total_revenue_cents": 11.724982599999999,
"users": 2
}
],
"timestamp": "2020-09-10T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

InstallsRatioGroupQueryResult

{"result": [{"result": [{"active_users": 3,
"country_code": "EH",
"installs_ratio": 0.6666666666666666,
"new_users": 2
},
{"active_users": 2,
"country_code": "SJ",
"installs_ratio": 0.5,
"new_users": 1
},
{"active_users": 1008,
"country_code": "CU",
"installs_ratio": 0.49107142857142855,
"new_users": 495
}
],
"timestamp": "2020-05-01T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

AdImpressionsCountGroupQueryResult

{"result": [{"result": [{"ad_impressions_count": 10023913,
"country_code": "BR"
},
{"ad_impressions_count": 5850502,
"country_code": "SK"
},
{"ad_impressions_count": 5352216,
"country_code": "MX"
}
],
"timestamp": "2020-12-01T00:00:00.000Z"
},
{"result": [{"ad_impressions_count": 9832383,
"country_code": "BR"
},
{"ad_impressions_count": 3383932,
"country_code": "SK"
},
{"ad_impressions_count": 3002235,
"country_code": "MX"
}
],
"timestamp": "2020-12-02T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

SessionsPerUserGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"session_unique": 68628741,
"sessions_per_user": 100,
"user_unique": 686287
},
{"country_code": "IN",
"session_unique": 35416211,
"sessions_per_user": 50,
"user_unique": 708324
},
{"country_code": "CN",
"session_unique": 17716756,
"sessions_per_user": 25,
"user_unique": 708670
}
],
"timestamp": "2020-04-27T00:00:00.000Z"
},
{"result": [{"country_code": "US",
"session_unique": 150024236,
"sessions_per_user": 100,
"user_unique": 1500242
},
{"country_code": "IN",
"session_unique": 80003576,
"sessions_per_user": 50,
"user_unique": 1600072
},
{"country_code": "CN",
"session_unique": 38386893,
"sessions_per_user": 25,
"user_unique": 1535476
}
],
"timestamp": "2020-05-04T00:00:00.000Z"
}
]
}

ilrd_count_per_active_user

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

Returns ilrd_count_per_active_user metrics matching the provided request.

Authorizations:

api_key

Request Body schema: application/json
required

ilrd_count_per_active_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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

IlrdCountPerActiveUserGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"ilrd_count_per_active_user": 0.03912236416666667,
"impression_count": 46.94683700000001,
"users": 12
},
{"country_code": "FR",
"ilrd_count_per_active_user": 0.019541637666666663,
"impression_count": 11.724982599999999,
"users": 6
}
],
"timestamp": "2020-09-10T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

Example

GameRetentionAheadQuery

{"days_ahead": 14,
"filter": {"and": [{"or": [{"country_code": ["CN",
"IN"
],
"is_paying": "true"
}
]
},
{"platform": "ios11"
}
]
},
"game": "2923",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimensions": ["country_code",
"platform"
],
"type": "split"
}
}

Response samples

Content type

application/json

{"result": [{"result": {"game_id": "96225",
"platform": "android",
"retention": 0.19018832473109884
},
"timestamp": "2020-05-01T00:00:00Z"
},
{"result": {"game_id": "46788",
"platform": "ios",
"retention": 0.18692793063721103
},
"timestamp": "2020-05-01T00:00:00Z"
},
{"result": {"game_id": "96225",
"platform": "android",
"retention": 0.18565159779459542
},
"timestamp": "2020-05-02T00:00:00Z"
},
{"result": {"game_id": "46788",
"platform": "ios",
"retention": 0.19294518378667583
},
"timestamp": "2020-05-02T00:00:00Z"
}
]
}

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

Payload

Content type

application/json

Example

GameConversionQuery

{"filter": {"and": [{"or": [{"country_code": ["CN",
"IN"
],
"is_paying": "true"
}
]
},
{"platform": "ios11"
}
]
},
"game": "2923",
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
}
}

Response samples

Content type

application/json

Example

ConversionGroupQueryResult

{"result": [{"result": [{"active_users": 39,
"conversion": 0.02564102564102564,
"country_code": "IS",
"paying_users": 1
},
{"active_users": 926,
"conversion": 0.0010799136069114472,
"country_code": "PR",
"paying_users": 1
}
],
"timestamp": "2020-04-27T00:00:00.000Z"
},
{"result": [{"active_users": 236,
"conversion": 0.00423728813559322,
"country_code": "DK",
"paying_users": 1
},
{"active_users": 1414,
"conversion": 0.0007072135785007072,
"country_code": "SE",
"paying_users": 1
}
],
"timestamp": "2020-05-04T00:00:00.000Z"
},
{"result": [{"active_users": 638,
"conversion": 0.001567398119122257,
"country_code": "CH",
"paying_users": 1
},
{"active_users": 1063,
"conversion": 0.0009407337723424271,
"country_code": "SG",
"paying_users": 1
}
],
"timestamp": "2020-05-11T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

ArpuGroupQueryResult

{"result": [{"result": [{"arpu": 0.04103201367725278,
"country_code": "DE",
"total_revenue": 4017625,
"users": 979144
},
{"arpu": 0.02856968215158924,
"country_code": "ZW",
"total_revenue": 11685,
"users": 4090
},
{"arpu": 0.0200098231827112,
"country_code": "CD",
"total_revenue": 6111,
"users": 3054
}
],
"timestamp": "2020-04-27T00:00:00.000Z"
},
{"result": [{"arpu": 0.2261350171499844,
"country_code": "ZW",
"total_revenue": 145043,
"users": 6414
},
{"arpu": 0.06855488939425264,
"country_code": "HT",
"total_revenue": 33160,
"users": 4837
},
{"arpu": 0.028745698317870223,
"country_code": "YE",
"total_revenue": 104413,
"users": 36323
}
],
"timestamp": "2020-05-04T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

IlrdRevenuePerSessionGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"ilrd_revenue_per_session": 0.03912236416666667,
"session_unique": 12,
"sum_cents": 46.94683700000001
},
{"country_code": "FR",
"ilrd_revenue_per_session": 0.019541637666666663,
"session_unique": 6,
"sum_cents": 11.724982599999999
}
],
"timestamp": "2020-09-10T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

Example

GameConversionFtQuery

{"filter": {"and": [{"or": [{"country_code": ["CN",
"IN"
],
"is_paying": "true"
}
]
},
{"platform": "ios11"
}
]
},
"game": "2923",
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
}
}

Response samples

Content type

application/json

Example

ConversionFtGroupQueryResult

{"result": [{"event": {"active_users": 944891,
"conversion_ft": 0,
"converting_users": 0,
"game_id": "96225",
"platform": "android"
},
"timestamp": "2020-04-27T00:00:00.000Z",
"version": "v1"
},
{"event": {"active_users": 1358050,
"conversion_ft": 0.00011339788667574831,
"converting_users": 154,
"game_id": "46788",
"platform": "ios"
},
"timestamp": "2020-04-27T00:00:00.000Z",
"version": "v1"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

IlrdRevenueGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"event_count": 129,
"mean": 0.00706821054263566,
"sum": 0.91179916,
"sum_cents": 91.179916
},
{"country_code": "FR",
"event_count": 44,
"mean": 0.004224603886363636,
"sum": 0.18588257099999997,
"sum_cents": 18.588257099999996
}
],
"timestamp": "2020-10-12T00:00:00.000Z"
},
{"result": [{"country_code": "GB",
"event_count": 26,
"mean": 0.004509608692307692,
"sum": 0.11724982599999999,
"sum_cents": 11.724982599999999
},
{"country_code": "TR",
"event_count": 6,
"mean": 0.010395975833333333,
"sum": 0.062375855,
"sum_cents": 6.2375855
}
],
"timestamp": "2020-10-19T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

SessionLengthPerUserGroupQueryResult

{"result": [{"result": [{"country_code": "TK",
"session_length_per_user": 10388.75,
"session_length_sum": 124665,
"user_unique": 12
},
{"country_code": "TV",
"session_length_per_user": 8113.45,
"session_length_sum": 324538,
"user_unique": 40
},
{"country_code": "GN",
"session_length_per_user": 7955.423076923077,
"session_length_sum": 46125543,
"user_unique": 5798
}
],
"timestamp": "2021-11-01T00:00:00.000Z"
},
{"result": [{"country_code": "GN",
"session_length_per_user": 8889.901742677048,
"session_length_sum": 47952130,
"user_unique": 5394
},
{"country_code": "ER",
"session_length_per_user": 8668.14693877551,
"session_length_sum": 4247392,
"user_unique": 490
},
{"country_code": "TK",
"session_length_per_user": 8345.375,
"session_length_sum": 66763,
"user_unique": 8
}
],
"timestamp": "2021-11-08T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

AdImpressionsPerUserGroupQueryResult

{"result": [{"result": [{"ad_impressions_count": 59984,
"ad_impressions_per_user": 19994.666666666668,
"country_code": "KR",
"user_unique": 3
},
{"ad_impressions_count": 16536,
"ad_impressions_per_user": 16536,
"country_code": "SV",
"user_unique": 1
}
],
"timestamp": "2020-12-01T00:00:00.000Z"
},
{"result": [{"ad_impressions_count": 57315,
"ad_impressions_per_user": 11463,
"country_code": "KR",
"user_unique": 5
},
{"ad_impressions_count": 375642,
"ad_impressions_per_user": 4942.6578947368425,
"country_code": "PR",
"user_unique": 76
}
],
"timestamp": "2020-12-02T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

Example

GameReturningUsersQuery

{"filter": {"and": [{"or": [{"country_code": ["CN",
"IN"
],
"is_paying": "true"
}
]
},
{"platform": "ios11"
}
]
},
"game": "2923",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"since_days_ago": 14
}

Response samples

Content type

application/json

Example

ReturningUsersGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"returning_users": 22
}
],
"timestamp": "2020-05-06T00:00:00.000Z"
},
{"result": [{"country_code": "US",
"returning_users": 105
}
],
"timestamp": "2020-05-07T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

RevenueGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"event_count": 12730,
"mean": 3.966147682639434,
"sum": 50489.06,
"sum_cents": 5048906
},
{"country_code": "DE",
"event_count": 1229,
"mean": 32.69019528071603,
"sum": 40176.25,
"sum_cents": 4017625
},
{"country_code": "CA",
"event_count": 676,
"mean": 10.59181952662722,
"sum": 7160.07,
"sum_cents": 716007
}
],
"timestamp": "2020-04-27T00:00:00.000Z"
},
{"result": [{"country_code": "US",
"event_count": 26302,
"mean": 5.502502471294958,
"sum": 144726.82,
"sum_cents": 14472682
},
{"country_code": "AU",
"event_count": 1603,
"mean": 9.238933250155958,
"sum": 14810.01,
"sum_cents": 1481001
},
{"country_code": "BR",
"event_count": 869,
"mean": 16.6368584579977,
"sum": 14457.43,
"sum_cents": 1445743
}
],
"timestamp": "2020-05-04T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

EventCountGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"event_count": 1356138719
},
{"country_code": "IN",
"event_count": 857581649
},
{"country_code": "CN",
"event_count": 524427449
}
],
"timestamp": "2020-04-27T00:00:00.000Z"
},
{"result": [{"country_code": "US",
"event_count": 3113320604
},
{"country_code": "IN",
"event_count": 1911285048
},
{"country_code": "CN",
"event_count": 1058458273
}
],
"timestamp": "2020-05-04T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

Example

GameRetentionCountQuery

{"days_ahead": 14,
"filter": {"and": [{"or": [{"country_code": ["CN",
"IN"
],
"is_paying": "true"
}
]
},
{"platform": "ios11"
}
]
},
"game": "2923",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
}
}

Response samples

Content type

application/json

Example

RetentionCountGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"retention_count": 22
}
],
"timestamp": "2020-05-06T00:00:00.000Z"
},
{"result": [{"country_code": "US",
"retention_count": 105
}
],
"timestamp": "2020-05-07T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

Example

GameRetentionRetroQuery

{"filter": {"and": [{"or": [{"country_code": ["CN",
"IN"
],
"is_paying": "true"
}
]
},
{"platform": "ios11"
}
]
},
"game": "2923",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimensions": ["country_code",
"platform"
],
"type": "split"
},
"since_days_ago": 14
}

Response samples

Content type

application/json

{"result": [{"result": {"game_id": "96225",
"platform": "android",
"retention": 0.19018832473109884
},
"timestamp": "2020-05-01T00:00:00Z"
},
{"result": {"game_id": "46788",
"platform": "ios",
"retention": 0.18692793063721103
},
"timestamp": "2020-05-01T00:00:00Z"
},
{"result": {"game_id": "96225",
"platform": "android",
"retention": 0.18565159779459542
},
"timestamp": "2020-05-02T00:00:00Z"
},
{"result": {"game_id": "46788",
"platform": "ios",
"retention": 0.19294518378667583
},
"timestamp": "2020-05-02T00:00:00Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

NewUsersGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"new_users": 2338464
},
{"country_code": "CN",
"new_users": 1488089
},
{"country_code": "IN",
"new_users": 1169901
}
],
"timestamp": "2020-04-27T00:00:00.000Z"
},
{"result": [{"country_code": "US",
"new_users": 5043010
},
{"country_code": "CN",
"new_users": 2865983
},
{"country_code": "IN",
"new_users": 2598194
}
],
"timestamp": "2020-05-04T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

PayingUsersGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"paying_users": 9372
},
{"country_code": "GB",
"paying_users": 693
},
{"country_code": "JP",
"paying_users": 662
}
],
"timestamp": "2020-04-27T00:00:00.000Z"
},
{"result": [{"country_code": "US",
"paying_users": 18970
},
{"country_code": "JP",
"paying_users": 1588
},
{"country_code": "GB",
"paying_users": 1430
}
],
"timestamp": "2020-05-04T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

SessionLengthGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"event_count": 65897737,
"mean": 176.13341033243677,
"sum": 11606793151
},
{"country_code": "IN",
"event_count": 34606867,
"mean": 210.57152298704185,
"sum": 7287220690
},
{"country_code": "CN",
"event_count": 17950386,
"mean": 226.20372068879186,
"sum": 4060444101
}
],
"timestamp": "2020-04-27T00:00:00.000Z"
},
{"result": [{"country_code": "US",
"event_count": 148028851,
"mean": 179.90179644101946,
"sum": 26630656220
},
{"country_code": "IN",
"event_count": 78290686,
"mean": 206.84263983840938,
"sum": 16193852167
},
{"country_code": "CN",
"event_count": 37098460,
"mean": 222.53049552461206,
"sum": 8255538687
}
],
"timestamp": "2020-05-04T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

UserUniqueGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"user_unique": 9201608
},
{"country_code": "IN",
"user_unique": 3342482
},
{"country_code": "CN",
"user_unique": 3155935
}
],
"timestamp": "2020-04-27T00:00:00.000Z"
},
{"result": [{"country_code": "US",
"user_unique": 15347637
},
{"country_code": "IN",
"user_unique": 5379437
},
{"country_code": "CN",
"user_unique": 5057406
}
],
"timestamp": "2020-05-04T00:00:00.000Z"
}
]
}

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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

ArppuGroupQueryResult

{"result": [{"result": [{"arppu": 562.11,
"country_code": "SY",
"paying_users": 1,
"total_revenue": 56211
},
{"arppu": 162.49,
"country_code": "EG",
"paying_users": 19,
"total_revenue": 308731
},
{"arppu": 139.4,
"country_code": "DZ",
"paying_users": 3,
"total_revenue": 41820
}
],
"timestamp": "2020-04-27T00:00:00.000Z"
},
{"result": [{"arppu": 1450.43,
"country_code": "ZW",
"paying_users": 1,
"total_revenue": 145043
},
{"arppu": 165.8,
"country_code": "HT",
"paying_users": 2,
"total_revenue": 33160
},
{"arppu": 158.44,
"country_code": "LY",
"paying_users": 1,
"total_revenue": 15844
}
],
"timestamp": "2020-05-04T00:00:00.000Z"
}
]
}

Supported metrics

List of available metrics to query.

Authorizations:

api_key

Responses

Response samples

200
401

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_active_user",
"ilrd_count_per_active_user",
"ad_impressions_count",
"ad_impressions_per_user",
"ad_impressions_per_session"
]

ilrd_revenue_per_active_user

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

Returns ilrd_revenue_per_active_user metrics matching the provided request.

Authorizations:

api_key

Request Body schema: application/json
required

ilrd_revenue_per_active_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

Payload

Content type

application/json

{"filter": {"or": [{"and": [{"or": [{"country_code": ["CN",
"IN"
]
},
{"platform": "ios"
}
]
},
{"not": {"game_id": "393283"
}
}
]
},
{"is_paying": "true"
}
]
},
"games": ["2923",
"1983",
"29239",
"2264"
],
"granularity": "day",
"interval": "2012-01-01T00:00:00.000/2012-01-03T00:00:00.000",
"query": {"dimension": "country_code",
"limit": 100,
"type": "group"
},
"studios": ["1",
"29",
"72"
]
}

Response samples

Content type

application/json

Example

IlrdRevenuePerActiveUserGroupQueryResult

{"result": [{"result": [{"country_code": "US",
"ilrd_revenue_per_active_user": 0.03912236416666667,
"total_revenue": 46.94683700000001,
"users": 12
},
{"country_code": "FR",
"ilrd_revenue_per_active_user": 0.019541637666666663,
"total_revenue": 11.724982599999999,
"users": 6
}
],
"timestamp": "2020-09-10T00:00:00.000Z"
}
]
}

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

200
401
502
504

Content type

application/json

"2012-01-01T00:00:00.000/2012-01-03T00:00:00.000"

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

[{"id": "192388",
"title": "Gelix Run"
},
{"id": "97298383",
"title": "SnowBalls 4D"
}
]

dimensions

Supported dimensions

Returns list of supported dimensions.

Authorizations:

api_key

Responses

Response samples

200
401

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": ["ios",
"android",
null
]
}

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

[{"id": "1",
"name": "Odin"
},
{"id": "13",
"name": "Cavebit"
}
]

API Specification

Metrics API (1.21.7)

metrics

ad_impressions_per_session

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

converting_users

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

session_unique

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ilrd_arpu

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

installs_ratio

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ad_impressions_count

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

sessions_per_user

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ilrd_count_per_active_user

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

retention_ahead

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

conversion

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

arpu

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ilrd_revenue_per_session

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

conversion_ft

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required