Загрузка событий
Загружает информацию о событиях.
Пример использования: можно передавать в AppMetrica оффлайн события, если пользователь не заходит в приложение, чтобы его совершить. Например, событие полного восстановления энергии в игре или просмотр фильма на Smart TV.
Свойства событий можно передавать в параметрах запроса или в теле. При передаче данных в теле, к URL запроса необходимо добавить .csv. Подробнее в разделе Пример запроса.
Для привязки события к пользователю, необходимо использовать одно из следующих полей при запросе:
profile_idappmetrica_device_id
Внимание. Post API содержит ограничения на загрузку данных. Подробнее в разделе Ограничения.
Формат запроса
POST https://api.appmetrica.yandex.ru/logs/v1/import/events
? post_api_key=<string>
& application_id=<int>
& profile_id=<string>
& appmetrica_device_id=<int>
& event_name=<string>
& timestamp=<int>
& [event_json=<json>]
& [session_type=<string>]
& [ios_ifa=<string>]
& [ios_ifv=<string>]
& [google_aid=<string>]
& [windows_aid=<string>]
& [os_name=<string>]
& [os_version=<string>]
& [device_manufacturer=<string>]
& [device_model=<string>]
& [device_type=<string>]
& [device_locale=<string>]
& [app_version_name=<string>]
& [app_package_name=<string>]
& [connection_type=<string>]
& [operator_name=<string>]
& [mcc=<int>]
& [mnc=<int>]
& [device_ipv6=<string>]post_api_key * | Токен для загрузки данных. Его можно получить в разделе Настройки вашего приложения. |
application_id * | Числовой идентификатор приложения. |
profile_id * | Идентификатор профиля пользователя.. Post API позволяет загружать данные только для идентификаторов, которые предварительно были отправлены через SDK. Внимание. Не передавайте значение вместе с параметром appmetrica_device_id. Сервер принимает только один из параметров. |
appmetrica_device_id * | Хеш от уникального идентификатора устройства, который устанавливает AppMetrica. Post API позволяет загружать данные только для идентификаторов, которые предварительно были отправлены через SDK. Внимание. Не передавайте значение вместе с параметром profile_id. Сервер принимает только один из параметров. |
event_name * | Имя события. |
timestamp * | Время события в формате UNIX-time. Post API позволяет загрузить только те события, у которых разница между датой совершения события ( |
event_json | Атрибуты события, сериализованные в JSON. Параметры событий могут быть вложенными, например {"param1":"param2","param1":{"param2":"param3"}}. Подробнее о событиях в разделе . |
session_type | Тип сессии. Возможные значения:
Значение по умолчанию: |
ios_ifa | IFA устройства. |
ios_ifv | IFV устройства. |
google_aid | Google AID устройства. |
windows_aid | Windows AID устройства. |
os_name | Имя операционной системы на устройстве пользователя. Возможные значения: ios | android | windows. |
os_version | Версия операционной системы на устройстве пользователя. |
device_manufacturer | Производитель устройства. Например, Apple, Samsung. |
device_model | Модель устройства. Например, Galaxy S6, iPhone X. |
device_type | Тип устройства, определяется сервисом AppMetrica. Возможные значения: phone | tablet | phablet | tv | desktop | unknown. |
device_locale | Язык интерфейса устройства. Например, en_US |
app_version_name | Версия приложения в виде, как указана разработчиком. |
app_package_name | Имя пакета для Android или Bundle ID для iOS. Например, ru.yandex.sample.metrica. |
connection_type | Тип подключения устройства. Возможные значения: wifi | cell | unknown. |
operator_name | Имя оператора сотовой связи. Например, MegaFon. |
mcc | Мобильный код страны. Например, 250 |
mnc | Код мобильной сети. Например, 2 |
device_ipv6 | IP-адрес в момент совершения события в формате IPv6. Например, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147 |
post_api_key * | Токен для загрузки данных. Его можно получить в разделе Настройки вашего приложения. |
application_id * | Числовой идентификатор приложения. |
profile_id * | Идентификатор профиля пользователя.. Post API позволяет загружать данные только для идентификаторов, которые предварительно были отправлены через SDK. Внимание. Не передавайте значение вместе с параметром appmetrica_device_id. Сервер принимает только один из параметров. |
appmetrica_device_id * | Хеш от уникального идентификатора устройства, который устанавливает AppMetrica. Post API позволяет загружать данные только для идентификаторов, которые предварительно были отправлены через SDK. Внимание. Не передавайте значение вместе с параметром profile_id. Сервер принимает только один из параметров. |
event_name * | Имя события. |
timestamp * | Время события в формате UNIX-time. Post API позволяет загрузить только те события, у которых разница между датой совершения события ( |
event_json | Атрибуты события, сериализованные в JSON. Параметры событий могут быть вложенными, например {"param1":"param2","param1":{"param2":"param3"}}. Подробнее о событиях в разделе . |
session_type | Тип сессии. Возможные значения:
Значение по умолчанию: |
ios_ifa | IFA устройства. |
ios_ifv | IFV устройства. |
google_aid | Google AID устройства. |
windows_aid | Windows AID устройства. |
os_name | Имя операционной системы на устройстве пользователя. Возможные значения: ios | android | windows. |
os_version | Версия операционной системы на устройстве пользователя. |
device_manufacturer | Производитель устройства. Например, Apple, Samsung. |
device_model | Модель устройства. Например, Galaxy S6, iPhone X. |
device_type | Тип устройства, определяется сервисом AppMetrica. Возможные значения: phone | tablet | phablet | tv | desktop | unknown. |
device_locale | Язык интерфейса устройства. Например, en_US |
app_version_name | Версия приложения в виде, как указана разработчиком. |
app_package_name | Имя пакета для Android или Bundle ID для iOS. Например, ru.yandex.sample.metrica. |
connection_type | Тип подключения устройства. Возможные значения: wifi | cell | unknown. |
operator_name | Имя оператора сотовой связи. Например, MegaFon. |
mcc | Мобильный код страны. Например, 250 |
mnc | Код мобильной сети. Например, 2 |
device_ipv6 | IP-адрес в момент совершения события в формате IPv6. Например, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147 |
* Обязательный параметр
Коды ответа
| Код | Описание |
|---|---|
| 200 | Данные успешно загружены. |
| 403 | Запрос не содержит заголовка авторизации, либо указан неверный токен. |
| 400 | Запрос не содержит одного или нескольких обязательных параметров. |
| Код | Описание |
|---|---|
| 200 | Данные успешно загружены. |
| 403 | Запрос не содержит заголовка авторизации, либо указан неверный токен. |
| 400 | Запрос не содержит одного или нескольких обязательных параметров. |
Пример запроса
POST /logs/v1/import/events.csv?post_api_key=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012 HTTP/1.1
Host: api.appmetrica.yandex.com
Content-Length: 540i
Connection: close
device_model,device_ipv6,device_type,google_aid,app_package_name,operator_name,mnc,application_id,event_json,profile_id,event_name,event_timestamp
iPhone X,2a02:6b8::40c:6676:baff:fea6:53d8,phone,01234567-890a-bcde-f012-3456789abcde,com.yandex.sample.metrica,MegaFon,2,1111,"{""key"":""value_1""}",1234567890123456789,event_name_1,1234567890
iPhone X,2a02:6b8::40c:6676:baff:fea6:53d9,phone,fedcba98-7654-3210-fedc-ba9876543210,com.yandex.sample.metrica,MegaFon,2,1111,"{""key"":""value_2""}",9876543210987654321,event_name_2,1234567891POST /logs/v1/import/events?post_api_key=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012&device_model=iPhone%20X&device_ipv6=2a02%3A6b8%3A%3A40c%3A6676%3Abaff%3Afea6%3A53d8&device_type=phone&google_aid=01234567-890a-bcde-f012-3456789abcde&app_package_name=com.yandex.sample.metrica&operator_name=MegaFon&mnc=2&application_id=1111&event_json=%7B%22key%22%3A%22value%22%7D&profile_id=1234567890123456789&event_name=event_name&event_timestamp=1234567890 HTTP/1.1
Host: api.appmetrica.yandex.com
Content-Length: 0
Connection: close