Профили

Возвращает информацию о профилях, обновленных за определенный интервал дат.

Примечание

Новая версия ресурса — profiles_v2, ресурс profiles вскоре будет удален. В profiles_v2 добавлены обязательные параметры date_since и date_until.

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

GET https://api.appmetrica.yandex.ru/logs/v1/export/profiles_v2.{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>]
  & [version=<string>]
  & [update_timestamp=<string>]

`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`*	Разделенный запятой список полей для выборки. Список, который содержит все доступные поля (для быстрого копирования): profile_id,appmetrica_gender,appmetrica_birth_date,appmetrica_notifications_enabled,appmetrica_name,<any attribute name>,appmetrica_crashes,appmetrica_errors,appmetrica_first_session_date,appmetrica_last_start_date,appmetrica_push_opens,appmetrica_push_send_count,appmetrica_sdk_version,appmetrica_sessions,android_id,appmetrica_device_id,city,connection_type,country_iso_code,device_manufacturer,device_model,device_type,google_aid,ios_ifa,ios_ifv,mcc,mnc,operator_name,os_name,os_version,windows_aid,app_build_number,app_framework,app_package_name,app_version_name
`date_dimension`	Параметр определяет, относительно какого события считается дата: `default` — относительно момента, когда событие произошло на устройстве пользователя; `receive` — относительно момента, когда информация о событии была получена сервером.
`limit`	Ограничение на число элементов в списке. По умолчанию принимает максимальное значение. Совпадение результатов идентичных запросов не гарантируется (возможно отличие в сортировке результатов).
`use_utf8_bom`	Параметр, который включает использование метки порядка байтов. Значение по умолчанию: `false`.
`<any field name>`	Фильтрация выборки по значению любого из доступных полей. Поддерживается только операция проверки равенства.
`version`	Версия профиля.
`update_timestamp`	Время обновления профиля в формате UNIX-time.

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

В случае, если запрашиваются все доступные поля:

JSON

CSV

{
  "data": [
    {
      "profile_id": "string",
      "appmetrica_gender": "string",
      "appmetrica_birth_date": "string",
      "appmetrica_notifications_enabled": "boolean",
      "appmetrica_name": "string",
      "appmetrica_crashes": "integer",
      "appmetrica_errors": "integer",
      "appmetrica_first_session_date": "string",
      "appmetrica_last_start_date": "string",
      "appmetrica_push_opens": "integer",
      "appmetrica_push_send_count": "integer",
      "appmetrica_sdk_version": "integer",
      "appmetrica_sessions": "integer",
      "android_id": "string",
      "appmetrica_device_id": "integer",
      "city": "string",
      "connection_type": "string",
      "country_iso_code": "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",
      "os_name": "string",
      "os_version": "string",
      "windows_aid": "string",
      "app_build_number": "integer",
      "app_framework": "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
...

`profile_id`	Идентификатор пользовательского профиля.
`appmetrica_gender`	Пол.
`appmetrica_birth_date`	Возраст.
`appmetrica_notifications_enabled`	Push разрешены.
`appmetrica_name`	Имя.
`appmetrica_crashes`	Количество крэшей.
`appmetrica_errors`	Количество ошибок.
`appmetrica_first_session_date`	Дата начала первой сессии.
`appmetrica_last_start_date`	Дата последнего запуска приложения.
`appmetrica_push_opens`	Количество открытых push-уведомлений.
`appmetrica_push_send_count`	Количество отправленных push-уведомлений.
`appmetrica_sdk_version`	Версия AppMetrica SDK.
`appmetrica_sessions`	Количество сессий.
`android_id`	Идентификатор Android.
`appmetrica_device_id`	Уникальный идентификатор устройства, который устанавливает AppMetrica. В Android от AppSetId, в IOS от IFV.
`city`	Название города на английском языке, где был произведен клик.
`connection_type`	Тип подключения устройства. Возможные значения: `wifi` \| `cell` \| `unknown`.
`country_iso_code`	ISO-код страны.
`device_manufacturer`	Производитель устройства, определяется сервисом AppMetrica (например, Apple или Samsung).
`device_model`	Модель устройства, определяется сервисом AppMetrica (например, Galaxy S6).
`device_type`	Тип устройства, определяется сервисом AppMetrica. Возможные значения: `phone` \| `tablet` \| `unknown`.
`google_aid`	Google AID устройства в формате, в котором получен от устройства.
`ios_ifa`	IFA устройства в формате, в котором получен от устройства.
`ios_ifv`	IFV для приложения в формате, в котором получен от устройства.
`mcc`	Мобильный код страны.
`mnc`	Код мобильной сети.
`operator_name`	Имя оператора сотовой связи.
`os_name`	Операционная система на устройстве пользователя: `ios` \| `android` \| `windows`.
`os_version`	Версия операционной системы на устройстве пользователя.
`windows_aid`	Windows AID устройства в формате, в котором получен от устройства.
`app_build_number`	Номер сборки приложения.
`app_framework`	Тип фреймворка. Возвращает следующие возможные значения: "0" — Native. "1" — Unity. "2" — Xamarin. "3" — React. "4" — Cordova.
`app_package_name`	Имя пакета для Android или Bundle ID для iOS (например, ru.yandex.metro).
`app_version_name`	Версия приложения в виде, как указана разработчиком.

Пример

Запрос:

curl -X GET \
  'https://api.appmetrica.yandex.ru/logs/v1/export/profiles_v2.json?application_id=1111&fields=profile_id,appmetrica_gender,appmetrica_birth_date,appmetrica_notifications_enabled,appmetrica_name,appmetrica_crashes,appmetrica_errors,appmetrica_first_session_date,appmetrica_last_start_date,appmetrica_push_opens,appmetrica_push_send_count,appmetrica_sdk_version,appmetrica_sessions,android_id,appmetrica_device_id,city,connection_type,country_iso_code,device_manufacturer,device_model,device_type,google_aid,ios_ifa,ios_ifv,mcc,mnc,operator_name,os_name,os_version,windows_aid,app_build_number,app_framework,app_package_name,app_version_name' \
  -H 'Authorization: OAuth oauth_token'

Ответ:

{
  "data": [
    {
      "profile_id": "test",
      "appmetrica_gender": "M",
      "appmetrica_birth_date": "30",
      "appmetrica_notifications_enabled": "false",
      "appmetrica_name": "John",
      "appmetrica_crashes": "1",
      "appmetrica_errors": "3",
      "appmetrica_first_session_date": "yyyy-mm-dd",
      "appmetrica_last_start_date": "yyyy-mm-dd",
      "appmetrica_push_opens": "3",
      "appmetrica_push_send_count": "8",
      "appmetrica_sdk_version": "3001000",
      "appmetrica_sessions": "15",
      "android_id": "android_id__example",
      "appmetrica_device_id": "123456789012345678",
      "city": "Moscow",
      "connection_type": "wifi",
      "country_iso_code": "RU",
      "device_manufacturer": "Apple",
      "device_model": "iPhone X",
      "device_type": "phone",
      "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",
      "os_name": "ios",
      "os_version": "12.2",
      "windows_aid": "windows_aid__example",
      "app_build_number": "1",
      "app_framework": "0",
      "app_package_name": "ru.yandex.metro",
      "app_version_name": "1.0"
    }
  ]
}

Если вы не нашли ответ на свой вопрос, то вы можете задать его через форму обратной связи. Пожалуйста, опишите возникшую проблему как можно подробнее. Если возможно, приложите скриншот.

Написать в службу поддержки

Была ли статья полезна?

E-commerce

Revenue