Revenue

Returns in-app purchase data for a specific date range.

  1. Request format
  2. Response format
  3. Example

Request format

GET https://api.appmetrica.yandex.ru/logs/v1/export/revenue_events.{csv | json}
 ? application_id=<int>
 & date_since=<string>
 & date_until=<string>
 & fields=<string>
 & [date_dimension=<string>]
 & [limit=<string>]
 & [use_utf8_bom=<bool>]
 & [<any field name>=<string>]
application_id *

Filtering by the app's numeric ID in AppMetrica

date_since *

Start of the date range in the yyyy-mm-dd hh:mm:ss format. You can also define the date and time type that affects the data in the date_dimension query parameter.

date_until *

End of the date range in the yyyy-mm-dd hh:mm:ss format. You can also define the date and time type that affects the data in the date_dimension query parameter.

fields *

A comma-separated list of fields for the sample.

A list that contains all available fields (for quick copy):

revenue_quantity,revenue_price,revenue_currency,revenue_product_id,revenue_order_id,revenue_order_id_source,is_revenue_verified,event_datetime,event_name,event_receive_datetime,event_receive_timestamp,event_timestamp,session_id,installation_id,android_id,appmetrica_device_id,appmetrica_sdk_version,city,connection_type,country_iso_code,device_ipv6,device_locale,device_manufacturer,device_model,google_aid,ios_ifa,ios_ifv,mcc,mnc,operator_name,original_device_model,os_version,profile_id,windows_aid,app_build_number,app_package_name,app_version_name
Copied to clipboard
date_dimension
The parameter defines what date and time are used as a condition for getting into the data sample:
  • default — When the event occurred on the device;
  • receive — When the server received event information.
limit

Limit on the number of items in the list. Takes the maximum value by default. There is no guarantee that results will match from request to request (there may be differences in results sorting).

use_utf8_bom

Parameter that enables the use of byte order mark. The default value is false.

<any field name>

Filtering by the value of one of the available fields. Only the equality check operation is supported.

application_id *

Filtering by the app's numeric ID in AppMetrica

date_since *

Start of the date range in the yyyy-mm-dd hh:mm:ss format. You can also define the date and time type that affects the data in the date_dimension query parameter.

date_until *

End of the date range in the yyyy-mm-dd hh:mm:ss format. You can also define the date and time type that affects the data in the date_dimension query parameter.

fields *

A comma-separated list of fields for the sample.

A list that contains all available fields (for quick copy):

revenue_quantity,revenue_price,revenue_currency,revenue_product_id,revenue_order_id,revenue_order_id_source,is_revenue_verified,event_datetime,event_name,event_receive_datetime,event_receive_timestamp,event_timestamp,session_id,installation_id,android_id,appmetrica_device_id,appmetrica_sdk_version,city,connection_type,country_iso_code,device_ipv6,device_locale,device_manufacturer,device_model,google_aid,ios_ifa,ios_ifv,mcc,mnc,operator_name,original_device_model,os_version,profile_id,windows_aid,app_build_number,app_package_name,app_version_name
Copied to clipboard
date_dimension
The parameter defines what date and time are used as a condition for getting into the data sample:
  • default — When the event occurred on the device;
  • receive — When the server received event information.
limit

Limit on the number of items in the list. Takes the maximum value by default. There is no guarantee that results will match from request to request (there may be differences in results sorting).

use_utf8_bom

Parameter that enables the use of byte order mark. The default value is false.

<any field name>

Filtering by the value of one of the available fields. Only the equality check operation is supported.

* Required

Response format

If all available fields are requested:
{
  "data": [
    {
      "revenue_quantity": "integer",
      "revenue_price": "string",
      "revenue_currency": "string",
      "revenue_product_id": "string",
      "revenue_order_id": "string",
      "revenue_order_id_source": "string",
      "is_revenue_verified": "string",
      "event_datetime": "string",
      "event_name": "string",
      "event_receive_datetime": "string",
      "event_receive_timestamp": "integer",
      "event_timestamp": "integer",
      "session_id": "integer",
      "installation_id": "string",
      "android_id": "string",
      "appmetrica_device_id": "integer",
      "appmetrica_sdk_version": "integer",
      "city": "string",
      "connection_type": "string",
      "country_iso_code": "string",
      "device_ipv6": "string",
      "device_locale": "string",
      "device_manufacturer": "string",
      "device_model": "string",
      "google_aid": "string",
      "ios_ifa": "string",
      "ios_ifv": "string",
      "mcc": "integer",
      "mnc": "integer",
      "operator_name": "string",
      "original_device_model": "string",
      "os_version": "string",
      "profile_id": "string",
      "windows_aid": "string",
      "app_build_number": "integer",
      "app_package_name": "string",
      "app_version_name": "string"
    },
    ...
  ]
}
Copied to clipboard
revenue_quantity
Number of purchases (item quantity).
revenue_price
Cost. It can be negative (like for refunds).
revenue_currency
Currency code of the purchase in ISO 4217 format.
revenue_product_id
Product ID.
revenue_order_id
Order ID.
revenue_order_id_source
Source of the order ID. Possible values: autogenerated | user_defined.
is_revenue_verified
The flag that indicates the purchase verification in the store. Possible values:
  • true — Verified;
  • false — Verified and rejected.
  • undefined — Unknown.
event_datetime
Date and time of the event in yyyy-mm-dd hh:mm:ss format.
event_name
Name of the event (as passed to the SDK).
event_receive_datetime
Date and time when the install event was received on the server side. May differ from event_datetime due to network delays or if the user's device was not connected at the time of the event.
event_receive_timestamp
Time when the event was received on the server side, in Unix timestamp format. May differ fromevent_timestamp due to network delays or if the user's device was not connected at the time of the event.
event_timestamp
Time of the event in UNIX-time format.
session_id
Session ID.
installation_id
Installation ID.
android_id
Android ID.
appmetrica_device_id
A unique device identifier detected by the AppMetrica service.
appmetrica_sdk_version
AppMetrica SDK version.
city
The name in English of the city where the click took place.
connection_type
Device connection type. Possible values: wifi | cell | unknown.
country_iso_code
ISO country code.
device_ipv6
The IP address at the time of event, in IPv6 format. For example, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147
device_locale
The device language.
device_manufacturer
The device manufacturer as detected by the AppMetrica service (for example, Apple or Samsung).
device_model
The device model as detected by the AppMetrica service (for example, Galaxy S6).
google_aid
Google AID device in the format received from the device.
ios_ifa
IFA of the device in the format received from the device.
ios_ifv
IFV for the app in the format received from the device.
mcc
Mobile country code.
mnc
Mobile network code.
operator_name
Name of the mobile operator.
original_device_model
Factory model of the device (for example, the following values are possible for Galaxy S8: SM-G9550, SM-G9558, and so on).
os_version
Version of the operating system on the user's device.
profile_id
User profile ID.
windows_aid
Windows AID of the device in the format received from the device.
app_build_number
App build number.
app_package_name
Package name for Android or Bundle ID for iOS (for example, ru.yandex.metro).
app_version_name
Version of the app as specified by the developer.

Example

Request:
curl -X GET \
  'https://api.appmetrica.yandex.ru/logs/v1/export/revenue_events.json?application_id=1111&date_since=2018-10-10&date_until=2018-10-11&fields=revenue_quantity,revenue_price,revenue_currency,revenue_product_id,revenue_order_id,revenue_order_id_source,is_revenue_verified,event_datetime,event_name,event_receive_datetime,event_receive_timestamp,event_timestamp,session_id,installation_id,android_id,appmetrica_device_id,appmetrica_sdk_version,city,connection_type,country_iso_code,device_ipv6,device_locale,device_manufacturer,device_model,google_aid,ios_ifa,ios_ifv,mcc,mnc,operator_name,original_device_model,os_version,profile_id,windows_aid,app_build_number,app_package_name,app_version_name' \
  -H 'Authorization: OAuth oauth_token'
Copied to clipboard

Response:

{
  "data": [
    {
      "revenue_quantity": "3",
      "revenue_price": "299",
      "revenue_currency": "RUB",
      "revenue_product_id": "",
      "revenue_order_id": "",
      "revenue_order_id_source": "autogenerated",
      "is_revenue_verified": "true",
      "event_datetime": "yyyy-mm-dd hh:mm:ss",
      "event_name": "New person",
      "event_receive_datetime": "yyyy-mm-dd hh:mm:ss",
      "event_receive_timestamp": "1556258667",
      "event_timestamp": "1556258660",
      "session_id": "10000000049",
      "installation_id": "",
      "android_id": "",
      "appmetrica_device_id": "123456789012345678",
      "appmetrica_sdk_version": "3001000",
      "city": "Moscow",
      "connection_type": "wifi",
      "country_iso_code": "RU",
      "device_ipv6": "::ffff:5.255.232.147",
      "device_locale": "ru_RU",
      "device_manufacturer": "Apple",
      "device_model": "iPhone X",
      "google_aid": "",
      "ios_ifa": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "ios_ifv": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "mcc": "250",
      "mnc": "1",
      "operator_name": "MTS RUS",
      "original_device_model": "iPhone10,3",
      "os_version": "12.2",
      "profile_id": "test",
      "windows_aid": "",
      "app_build_number": "1",
      "app_package_name": "ru.yandex.metro",
      "app_version_name": "1.0"
    }
  ]
}
Copied to clipboard