Трекинговые клики и показы

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

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

GET https://api.appmetrica.yandex.ru/logs/v1/export/clicks.{csv | json}
  ? application_id=<int>
  & date_since=<string>
  & date_until=<string>
  & fields=<string>
  & [date_dimension=<string>]
  & [limit=<int>]
  & [use_utf8_bom=<bool>]
  & [<any field name>=<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*

Разделенный запятой список полей для выборки.

Список, который содержит все доступные поля (для быстрого копирования):

application_id,click_datetime,click_id,click_ipv6,click_timestamp,click_url_parameters,click_user_agent,publisher_id,publisher_name,tracker_name,tracking_id,touch_type,is_bot,city,country_iso_code,device_manufacturer,device_model,device_type,google_aid,oaid,ios_ifa,ios_ifv,os_name,os_version,windows_aid

date_dimension

Параметр определяет, относительно какого события считается дата:

  • default — относительно момента, когда событие произошло на устройстве пользователя;
  • receive — относительно момента, когда информация о событии была получена сервером.

limit

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

use_utf8_bom

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

<any field name>

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

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

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

{
  "data": [
    {
      "application_id": "integer",
      "touch_type": "string",
      "click_datetime": "string",
      "click_id": "string",
      "click_ipv6": "string",
      "click_timestamp": "integer",
      "click_url_parameters": "string",
      "click_user_agent": "string",
      "publisher_id": "integer",
      "publisher_name": "string",
      "tracker_name": "string",
      "tracking_id": "integer",
      "city": "string",
      "country_iso_code": "string",
      "device_type": "string",
      "device_model": "string",
      "device_manufacturer": "string",
      "os_version": "string",
      "os_name": "string",
      "windows_aid": "string",
      "google_aid": "string",
      "oaid": "string",
      "ios_ifv": "string",
      "ios_ifa": "string",
      "is_bot": "boolean"
    },
    ...
  ]
}

application_id,ios_ifa,os_name,...
1111,024AE7EB-4128-4237-9803-D24950323D4D,ios,...
1111,3A86D5E8-1985-4A23-B147-5A1C0CF8781E,ios,...
1111,,android
...

application_id

Уникальный числовой идентификатор приложения в AppMetrica.

touch_type

Тип: клик или показ. Возможные значения: click | impression | unknown.

click_datetime

Дата и время клика/показа в формате yyyy-mm-dd hh:mm:ss.

click_id

Идентификатор клика/показа или '' (пустая строка, если недоступен).

click_ipv6

IP-адрес в момент клика/показа в формате IPv6. Например, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147.

click_timestamp

Время клика/показа в формате UNIX-time в секундах.

click_url_parameters

Параметры, как они представлены в ссылке. При этом специальные символы необходимо экранировать (например, ?param1=1&param2=2... будет выглядеть в запросе как ?param1%3D1%26param2%3D2...).

click_user_agent

User-agent клика/показа.

publisher_id

ID партнера в AppMetrica. Может использоваться для определения партнера в отчетах AppMetrica. Если для трекера включены неатрибуцированные постбеки, то значение поля будет равно 0.

publisher_name

Название партнера AppMetrica. Если для трекера включены неатрибуцированные постбеки, то значение поля будет пустым.

tracker_name

Название трекера, который добавляется в интерфейсе AppMetrica. Если для трекера включены неатрибуцированные постбеки, то значение поля будет пустым.

tracking_id

ID трекера в AppMetrica. Может использоваться для определения партнера в отчетах AppMetrica. Если для трекера включены неатрибуцированные постбеки, то значение поля будет равно 0.

city

Название города на английском языке, где был произведен клик.

country_iso_code

ISO-код страны.

device_manufacturer

Производитель устройства, определяется сервисом AppMetrica (например, Apple или Samsung).

device_model

Модель устройства, определяется сервисом AppMetrica (например, Galaxy S6).

device_type

Тип устройства, определяется сервисом AppMetrica. Возможные значения: phone | tablet | unknown.

google_aid

Google AID устройства в формате, в котором получен от устройства.

oaid

Huawei OAID устройства в формате, в котором получен от устройства.

ios_ifa

IFA устройства в формате, в котором получен от устройства.

ios_ifv

IFV для приложения в формате, в котором получен от устройства.

os_name

Операционная система на устройстве пользователя: ios | android | windows.

os_version

Версия операционной системы на устройстве пользователя.

windows_aid

Windows AID устройства в формате, в котором получен от устройства.

is_bot

Признак клика, совершённого не из браузера.

Пример

Запрос:

curl -X GET \
  'https://api.appmetrica.yandex.ru/logs/v1/export/clicks.json?application_id=1111&date_since=2018-10-10&date_until=2018-10-11&fields=application_id,touch_type,click_datetime,click_id,click_ipv6,click_timestamp,click_url_parameters,click_user_agent,publisher_id,publisher_name,tracker_name,tracking_id,city,country_iso_code,device_type,device_model,device_manufacturer,os_version,os_name,windows_aid,google_aid,oaid,ios_ifv,ios_ifa,is_bot' \
  -H 'Authorization: OAuth oauth_token'

Ответ:

{
  "data": [
    {
      "application_id": "1111",
      "touch_type": "click",
      "click_datetime": "yyyy-mm-dd hh:mm:ss",
      "click_id": "f2ae4254de8844dda58b29cac2cf0e87",
      "click_ipv6": "::ffff:5.255.232.147",
      "click_timestamp": "1556258660",
      "click_timestamp": "1556258660",
      "click_url_parameters": "click_id=f2ae4254de8844dda58b29cac2cf0e87&c=1234&google_aid=&google_aid_sha1=&google_aid_md5=&ios_ifa=&ios_ifa_sha1=&ios_ifa_md5&click_timestamp=1554824136&afpub_id=&site_id=&creative_id=&goal_id1=&goal_id2 ",
      "click_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1 Mobile/15E148 Safari/604.1",
      "publisher_id": "39",
      "publisher_name": "AdColony",
      "tracker_name": "Advertising iOS campaign",
      "tracking_id": "12345678901234567890",
      "city": "Moscow",
      "country_iso_code": "RU",
      "device_type": "phone",
      "device_model": "iPhone X",
      "device_manufacturer": "Apple",
      "os_version": "12.2",
      "os_name": "ios",
      "windows_aid": "",
      "google_aid": "",
      "oaid": "",
      "ios_ifv": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "ios_ifa": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "is_bot": "false"
    }
  ]
}

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

Написать в службу поддержки
Предыдущая
Ресурсы API
Следующая
Установки приложения