E-commerce
Возвращает данные о покупках за определенный интервал дат.
Формат запроса
GET https://api.appmetrica.yandex.ru/logs/v1/export/ecommerce_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": [
{
"ecom_type": "string",
"ecom_screen_name": "string",
"ecom_screen_search_query": "string",
"ecom_screen_payload": "string",
"ecom_screen_category_path_1": "string",
"ecom_screen_category_path_2": "string",
"ecom_screen_category_path_3": "string",
"ecom_screen_category_path_4": "string",
"ecom_screen_category_path_5": "string",
"ecom_screen_category_path_6": "string",
"ecom_screen_category_path_7": "string",
"ecom_screen_category_path_8": "string",
"ecom_screen_category_path_9": "string",
"ecom_screen_category_path_10": "string",
"ecom_product_name": "string",
"ecom_product_sku": "integer",
"ecom_product_promocodes": "string",
"ecom_product_payload": "string",
"ecom_product_category_path_1": "string",
"ecom_product_category_path_2": "string",
"ecom_product_category_path_3": "string",
"ecom_product_category_path_4": "string",
"ecom_product_category_path_5": "string",
"ecom_product_category_path_6": "string",
"ecom_product_category_path_7": "string",
"ecom_product_category_path_8": "string",
"ecom_product_category_path_9": "string",
"ecom_product_category_path_10": "string",
"ecom_product_actual_price_fiat_unit_type": "string",
"ecom_product_actual_price_fiat_value": "string",
"ecom_product_actual_price_internal_components": "string",
"ecom_product_original_price_fiat_unit_type": "string",
"ecom_product_original_price_fiat_value": "string",
"ecom_product_original_price_internal_components": "string",
"ecom_cart_item_price_fiat_unit_type": "string",
"ecom_cart_item_price_fiat_value": "string",
"ecom_cart_item_quantity": "integer",
"ecom_cart_item_internal_components": "string",
"ecom_referrer_type": "string",
"ecom_referrer_id": "integer",
"ecom_order_id": "integer",
"ecom_order_payload": "string",
"event_datetime": "string",
"event_json": "string",
"event_name": "string",
"event_receive_datetime": "string",
"event_receive_timestamp": "integer",
"event_timestamp": "integer",
"session_id": "integer",
"installation_id": "string",
"appmetrica_device_id": "integer",
"city": "string",
"connection_type": "string",
"country_iso_code": "string",
"device_ipv6": "string",
"device_locale": "string",
"device_manufacturer": "string",
"device_model": "string",
"device_type": "string",
"google_aid": "string",
"ios_ifa": "string",
"ios_ifv": "string",
"mcc": "integer",
"mnc": "integer",
"operator_name": "string",
"original_device_model": "string",
"os_name": "string",
"os_version": "string",
"profile_id": "string",
"windows_aid": "string",
"app_build_number": "integer",
"app_package_name": "string",
"app_version_name": "string",
"application_id": "integer"
},
...
]
}
application_id,ios_ifa,os_name,...
1111,024AE7EB-4128-4237-9803-D24950323D4D,ios,...
1111,3A86D5E8-1985-4A23-B147-5A1C0CF8781E,ios,...
1111,,android
...
|
Тип события покупки. Возможные значения:
|
|
Название экрана. |
|
Поисковый запрос. |
|
Параметры экрана, как передали в SDK. Имеет формат объекта JSON “строковые ключ-значение”, например:
|
|
Категория экрана. Уровень 1. |
|
Категория экрана. Уровень 2. |
|
Категория экрана. Уровень 3. |
|
Категория экрана. Уровень 4. |
|
Категория экрана. Уровень 5. |
|
Категория экрана. Уровень 6. |
|
Категория экрана. Уровень 7. |
|
Категория экрана. Уровень 8. |
|
Категория экрана. Уровень 9. |
|
Категория экрана. Уровень 10. |
|
Название товара. |
|
ID товара. |
|
Промокоды товара. Имеет формат списка строк JSON, например:
|
|
Параметры товара, как передали в SDK. Имеет формат объекта JSON “строковые ключ-значение”, например:
|
|
Категория товара. Уровень 1. |
|
Категория товара. Уровень 2. |
|
Категория товара. Уровень 3. |
|
Категория товара. Уровень 4. |
|
Категория товара. Уровень 5. |
|
Категория товара. Уровень 6. |
|
Категория товара. Уровень 7. |
|
Категория товара. Уровень 8. |
|
Категория товара. Уровень 9. |
|
Категория товара. Уровень 10. |
|
Валюта актуальной стоимости товара. |
|
Актуальная стоимость товара. |
|
Составляющие актуальной стоимости товара. Имеет формат списка JSON-объектов-пар “ключ-значение”, например:
|
|
Валюта базовой стоимости товара. |
|
Базовая стоимость товара. |
|
Составляющие базовой стоимости товара. Имеет формат списка JSON-объектов-пар “ключ-значение”, например:
|
|
Валюта стоимости товара в корзине. |
|
Стоимость товара в корзине. |
|
Количество товара в корзине. |
|
Составляющие стоимости товара в корзине. Имеет формат списка JSON-объектов-пар “ключ-значение”, например:
|
|
Тип источника перехода. |
|
ID источника перехода. |
|
ID покупки. |
|
Параметры покупки, как передали в SDK. Имеет формат объекта JSON “строковые ключ-значение”, например:
|
|
Дата и время события в формате |
|
Имя события (как передано в SDK). |
|
Дата и время получения сервером события. Может отличаться от |
|
Время получения сервером события в формате UNIX-time. Может отличаться от |
|
Время события в формате UNIX-time. Post API позволяет загрузить только те события, у которых разница между датой совершения события ( |
|
Идентификатор сессии. Набор из значений |
|
Идентификатор установки. |
|
Название города на английском языке, где был произведен клик. |
|
Тип подключения устройства. Возможные значения: |
|
ISO-код страны. |
|
IP-адрес в момент совершения события в формате IPv6. Например, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147. |
|
Язык интерфейса устройства. |
|
Производитель устройства, определяется сервисом AppMetrica (например, Apple или Samsung). |
|
Модель устройства, определяется сервисом AppMetrica (например, Galaxy S6). |
|
Тип устройства, определяется сервисом AppMetrica. Возможные значения: |
|
Google AID устройства в формате, в котором получен от устройства. |
|
IFA устройства в формате, в котором получен от устройства. |
|
IFV для приложения в формате, в котором получен от устройства. |
|
Мобильный код страны. |
|
Код мобильной сети. |
|
Имя оператора сотовой связи. |
|
Заводская модель устройства (например, для Galaxy S8 возможны следующие значения: SM-G9550, SM-G9558 и т. д.). |
|
Операционная система на устройстве пользователя: |
|
Версия операционной системы на устройстве пользователя. |
|
Идентификатор пользовательского профиля. |
|
Windows AID устройства в формате, в котором получен от устройства. |
|
Номер сборки приложения. |
|
Имя пакета для Android или Bundle ID для iOS (например, ru.yandex.metro). |
|
Версия приложения в виде, как указана разработчиком. |
|
Уникальный числовой идентификатор приложения в AppMetrica. |
Пример
Запрос:
curl -X GET \
'https://api.appmetrica.yandex.ru/logs/v1/export/ecommerce_events.json?application_id=2421017&date_since=2023-01-04+00%3A00%3A00&date_until=2023-01-04+23%3A59%3A59&date_dimension=receive&use_utf8_bom=true&fields=ecom_type,ecom_screen_name,ecom_screen_search_query,ecom_screen_payload,ecom_screen_category_path_1,ecom_screen_category_path_2,ecom_screen_category_path_3,ecom_screen_category_path_4,ecom_screen_category_path_5,ecom_screen_category_path_6,ecom_screen_category_path_7,ecom_screen_category_path_8,ecom_screen_category_path_9,ecom_screen_category_path_10,ecom_product_name,ecom_product_sku,ecom_product_promocodes,ecom_product_payload,ecom_product_category_path_1,ecom_product_category_path_2,ecom_product_category_path_3,ecom_product_category_path_4,ecom_product_category_path_5,ecom_product_category_path_6,ecom_product_category_path_7,ecom_product_category_path_8,ecom_product_category_path_9,ecom_product_category_path_10,ecom_product_actual_price_fiat_unit_type,ecom_product_actual_price_fiat_value,ecom_product_actual_price_internal_components,ecom_product_original_price_fiat_unit_type,ecom_product_original_price_fiat_value,ecom_product_original_price_internal_components,ecom_cart_item_price_fiat_unit_type,ecom_cart_item_price_fiat_value,ecom_cart_item_quantity,ecom_cart_item_internal_components,ecom_referrer_type,ecom_referrer_id,ecom_order_id,ecom_order_payload,event_datetime,event_json,event_name,event_receive_datetime,event_receive_timestamp,event_timestamp,session_id,installation_id,appmetrica_device_id,city,connection_type,country_iso_code,device_ipv6,device_locale,device_manufacturer,device_model,device_type,google_aid,ios_ifa,ios_ifv,mcc,mnc,operator_name,original_device_model,os_name,os_version,profile_id,windows_aid,app_build_number,app_package_name,app_version_name,application_id' \
-H 'Authorization: OAuth oauth_token'
Ответ:
{
"data": [
{
"ecom_type": "show_screen",
"ecom_screen_name": "",
"ecom_screen_search_query": "",
"ecom_screen_payload": {
"full_screen": "true"
},
"ecom_screen_category_path_1": "",
"ecom_screen_category_path_2": "",
"ecom_screen_category_path_3": "",
"ecom_screen_category_path_4": "",
"ecom_screen_category_path_5": "",
"ecom_screen_category_path_6": "",
"ecom_screen_category_path_7": "",
"ecom_screen_category_path_8": "",
"ecom_screen_category_path_9": "",
"ecom_screen_category_path_10": "",
"ecom_product_name": "",
"ecom_product_sku": "",
"ecom_product_promocodes": [],
"ecom_product_payload": {},
"ecom_product_category_path_1": "",
"ecom_product_category_path_2": "",
"ecom_product_category_path_3": "",
"ecom_product_category_path_4": "",
"ecom_product_category_path_5": "",
"ecom_product_category_path_6": "",
"ecom_product_category_path_7": "",
"ecom_product_category_path_8": "",
"ecom_product_category_path_9": "",
"ecom_product_category_path_10": "",
"ecom_product_actual_price_fiat_unit_type": "",
"ecom_product_actual_price_fiat_value": 0,
"ecom_product_actual_price_internal_components": [],
"ecom_product_original_price_fiat_unit_type": "",
"ecom_product_original_price_fiat_value": 0,
"ecom_product_original_price_internal_components": [],
"ecom_cart_item_price_fiat_unit_type": "",
"ecom_cart_item_price_fiat_value": 0,
"ecom_cart_item_quantity": 0,
"ecom_cart_item_internal_components": [],
"ecom_referrer_type": "",
"ecom_referrer_id": "",
"ecom_order_id": "",
"ecom_order_payload": {},
"event_datetime": "2024-07-29 23:37:01",
"event_receive_datetime": "2024-07-29 23:37:14",
"event_name": "",
"event_receive_timestamp": 1722285434,
"event_timestamp": 1722285421,
"session_id": 10000000807,
"installation_id": "6559cf2bb96c44189ef889bc4976b240",
"appmetrica_device_id": 383777566819598200,
"city": "",
"connection_type": "wifi",
"country_iso_code": "RU",
"device_ipv6": "::ffff:79.173.67.100",
"device_locale": "ru_RU",
"device_manufacturer": "Realme",
"device_model": "realme C21",
"device_type": "phone",
"google_aid": "",
"ios_ifa": "",
"ios_ifv": "",
"mcc": 250,
"mnc": 1,
"operator_name": "MTS RUS",
"original_device_model": "RMX3201",
"os_name": "android",
"os_version": 11,
"profile_id": 107010519,
"windows_aid": "",
"app_build_number": 2024060301,
"app_package_name": "com.biglion",
"app_version_name": "7.4.40",
"application_id": 178725
},
...
]
}
См. также
Если вы не нашли ответ на свой вопрос, то вы можете задать его через форму обратной связи. Пожалуйста, опишите возникшую проблему как можно подробнее. Если возможно, приложите скриншот.