Покупки в приложении

Возвращает данные о покупках за определенный интервал дат.

  1. Формат запроса
  2. Формат ответа
  3. Пример

Формат запроса

GET https://api.appmetrica.yandex.ru/logs/v1/export/revenue_events.{csv | json | parts}
 ? application_id=<int>
 & date_since=<string>
 & date_until=<string>
 & fields=<string>
 & [date_dimension=<string>]
 & [limit=<string>]
 & [use_utf8_bom=<bool>]
 & [<any field name>=<string>]
Query-параметры
application_id *

Фильтрация выборки по числовому идентификатору приложения в AppMetrica.

date_since *

Начало интервала дат в формате yyyy-mm-dd hh:mm:ss. Также с помощью query-параметра date_dimension можно определить, относительно какого события считать дату.

date_until *

Конец интервала дат в формате yyyy-mm-dd hh:mm:ss. Также с помощью query-параметра date_dimension можно определить, относительно какого события считать дату.

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,event_datetime,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
date_dimension
Параметр определяет, относительно какого события считается дата:
  • default — относительно момента, когда событие произошло на устройстве пользователя;
  • receive — относительно момента, когда информация о событии была получена сервером.
limit

Ограничение на число элементов в списке. По умолчанию принимает максимальное значение. Совпадение результатов идентичных запросов не гарантируется (возможно отличие в сортировке результатов).

use_utf8_bom

Параметр, который включает использование метки порядка байтов. Значение по умолчанию: false.

<any field name>

Фильтрация выборки по значению любого из доступных полей. Поддерживается только операция проверки равенства.

*  Обязательный параметр

Формат ответа

В случае, если запрашиваются все доступные поля:
{
  "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",
      "event_datetime": "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"
    },
    ...
  ]
}
revenue_quantity
Количество покупок (купленных товаров).
revenue_price
Стоимость. Может быть отрицательной (например, для возврата).
revenue_currency
Код валюты покупки в формате ISO 4217.
revenue_product_id
Идентификатор товара.
revenue_order_id
Идентификатор заказа.
revenue_order_id_source
Источник идентификатора заказа. Возможные значения: autogenerated | user_defined.
is_revenue_verified
Признак верификации покупки в магазине. Возможные значения:
  • true — проверено;
  • false — проверено и отбраковано;
  • undefined — неизвестно.
event_datetime
Дата и время события в формате yyyy-mm-dd hh:mm:ss.
event_name
Имя события (как передано в SDK).
event_receive_datetime
Дата и время получения сервером события. Может отличаться от event_datetime из-за задержек в сети или отсутствия подключения у пользователя на момент события.
event_receive_timestamp
Время получения сервером события в формате UNIX-time. Может отличаться от event_timestamp из-за задержек в сети или отсутствия подключения у пользователя на момент события.
event_timestamp
Время события в формате UNIX-time.
session_id
Идентификатор сессии.
installation_id
Идентификатор установки.
android_id
Идентификатор Android.
appmetrica_device_id
Уникальный идентификатор устройства, который устанавливает AppMetrica.
appmetrica_sdk_version
Версия AppMetrica SDK.
city
Название города на английском языке, где был произведен клик.
connection_type
Тип подключения устройства. Возможные значения: wifi | cell | unknown.
country_iso_code
ISO-код страны.
device_ipv6
IP-адрес в момент совершения события в формате IPv6. Например, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147
device_locale
Язык интерфейса устройства.
device_manufacturer
Производитель устройства, определяется сервисом AppMetrica (например, Apple или Samsung).
device_model
Модель устройства, определяется сервисом AppMetrica (например, Galaxy S6).
event_datetime
Дата и время события в формате yyyy-mm-dd hh:mm:ss.
google_aid
Google AID устройства в формате, в котором получен от устройства.
ios_ifa
IFA устройства в формате, в котором получен от устройства.
ios_ifv
IFV для приложения в формате, в котором получен от устройства.
mcc
Мобильный код страны.
mnc
Код мобильной сети.
operator_name
Имя оператора сотовой связи.
original_device_model
Заводская модель устройства (например, для Galaxy S8 возможны следующие значения: SM-G9550, SM-G9558 и т. д.).
os_version
Версия операционной системы на устройстве пользователя.
profile_id
Идентификатор пользовательского профиля.
windows_aid
Windows AID устройства в формате, в котором получен от устройства.
app_build_number
Номер сборки приложения.
app_package_name
Имя пакета для Android или Bundle ID для iOS (например, ru.yandex.metro).
app_version_name
Версия приложения в виде, как указана разработчиком.

Пример

Запрос:
curl -X GET \
  'https://api.appmetrica.yandex.ru/logs/v1/export/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,event_datetime,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'

Ответ:

{
  "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",
      "event_datetime": "yyyy-mm-dd hh:mm:ss",
      "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"
    }
  ]
}