Revenue
Возвращает данные о покупках за определенный интервал дат.
Формат запроса
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>]
|
Фильтрация выборки по числовому идентификатору приложения в AppMetrica. |
|
Начало интервала дат в формате |
|
Конец интервала дат в формате |
|
Разделенный запятой список полей для выборки. Список, который содержит все доступные поля (для быстрого копирования):
|
|
Параметр определяет, относительно какого события считается дата:
|
|
Ограничение на число элементов в списке. По умолчанию принимает максимальное значение. Совпадение результатов идентичных запросов не гарантируется (возможно отличие в сортировке результатов). |
|
Параметр, который включает использование метки порядка байтов. Значение по умолчанию: |
|
Фильтрация выборки по значению любого из доступных полей. Поддерживается только операция проверки равенства. |
Формат ответа
В случае, если запрашиваются все доступные поля:
{
"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"
},
...
]
}
application_id,ios_ifa,os_name,...
1111,024AE7EB-4128-4237-9803-D24950323D4D,ios,...
1111,3A86D5E8-1985-4A23-B147-5A1C0CF8781E,ios,...
1111,,android
...
|
Количество покупок (купленных товаров). |
|
Стоимость. Может быть отрицательной (например, для возврата). |
|
Код валюты покупки в формате ISO 4217. |
|
Идентификатор товара. |
|
Идентификатор заказа. |
|
Источник идентификатора заказа. Возможные значения: |
|
Признак верификации покупки в магазине. Возможные значения:
|
|
Дата и время события в формате |
|
Имя события (как передано в SDK). |
|
Дата и время получения сервером события. Может отличаться от |
|
Время получения сервером события в формате UNIX-time. Может отличаться от |
|
Время события в формате UNIX-time. Post API позволяет загрузить только те события, у которых разница между датой совершения события ( |
|
Идентификатор сессии. Набор из значений |
|
Идентификатор установки. |
|
Идентификатор Android. |
|
Уникальный идентификатор устройства, который устанавливает AppMetrica. |
|
Версия AppMetrica SDK. |
|
Название города на английском языке, где был произведен клик. |
|
Тип подключения устройства. Возможные значения: |
|
ISO-код страны. |
|
IP-адрес в момент совершения события в формате IPv6. Например, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147. |
|
Язык интерфейса устройства. |
|
Производитель устройства, определяется сервисом AppMetrica (например, Apple или Samsung). |
|
Модель устройства, определяется сервисом AppMetrica (например, Galaxy S6). |
|
Google AID устройства в формате, в котором получен от устройства. |
|
IFA устройства в формате, в котором получен от устройства. |
|
IFV для приложения в формате, в котором получен от устройства. |
|
Мобильный код страны. |
|
Код мобильной сети. |
|
Имя оператора сотовой связи. |
|
Заводская модель устройства (например, для Galaxy S8 возможны следующие значения: SM-G9550, SM-G9558 и т. д.). |
|
Версия операционной системы на устройстве пользователя. |
|
Идентификатор пользовательского профиля. |
|
Windows AID устройства в формате, в котором получен от устройства. |
|
Номер сборки приложения. |
|
Имя пакета для Android или Bundle ID для iOS (например, ru.yandex.metro). |
|
Версия приложения в виде, как указана разработчиком. |
Пример
Запрос:
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'
Ответ:
{
"data": [
{
"revenue_quantity": "3",
"revenue_price": "299",
"revenue_currency": "RUB",
"revenue_product_id": "revenue_product_id__example",
"revenue_order_id": "revenue_order_id__example",
"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": "installation_id__example",
"android_id": "android_id__example",
"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": "google_aid__example",
"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": "windows_aid__example",
"app_build_number": "1",
"app_package_name": "ru.yandex.metro",
"app_version_name": "1.0"
}
]
}
Если вы не нашли ответ на свой вопрос, то вы можете задать его через форму обратной связи. Пожалуйста, опишите возникшую проблему как можно подробнее. Если возможно, приложите скриншот.