Tracking clicks and impressions

Returns data on tracking clicks and impressions for a specific date range.

  1. Request format
  2. Response format
  3. Example

Request format

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 *

Filtering by the app's numeric ID in AppMetrica

date_since *

Start of the date range in the yyyy-mm-dd hh:mm:ss format. You can also define the date and time type that affects the data in the date_dimension query parameter.

date_until *

End of the date range in the yyyy-mm-dd hh:mm:ss format. You can also define the date and time type that affects the data in the date_dimension query parameter.

fields *

A comma-separated list of fields for the sample.

A list that contains all available fields (for quick copy):

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,city,country_iso_code,device_type,device_model,device_manufacturer,os_version,os_name,windows_aid,google_aid,ios_ifv,ios_ifa
Copied to clipboard
date_dimension
The parameter defines what date and time are used as a condition for getting into the data sample:
  • default — When the event occurred on the device;
  • receive — When the server received event information.
limit

Limit on the number of items in the list. Takes the maximum value by default. There is no guarantee that results will match from request to request (there may be differences in results sorting).

use_utf8_bom

Parameter that enables the use of byte order mark. The default value is false.

<any field name>

Filtering by the value of one of the available fields. Only the equality check operation is supported.

application_id *

Filtering by the app's numeric ID in AppMetrica

date_since *

Start of the date range in the yyyy-mm-dd hh:mm:ss format. You can also define the date and time type that affects the data in the date_dimension query parameter.

date_until *

End of the date range in the yyyy-mm-dd hh:mm:ss format. You can also define the date and time type that affects the data in the date_dimension query parameter.

fields *

A comma-separated list of fields for the sample.

A list that contains all available fields (for quick copy):

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,city,country_iso_code,device_type,device_model,device_manufacturer,os_version,os_name,windows_aid,google_aid,ios_ifv,ios_ifa
Copied to clipboard
date_dimension
The parameter defines what date and time are used as a condition for getting into the data sample:
  • default — When the event occurred on the device;
  • receive — When the server received event information.
limit

Limit on the number of items in the list. Takes the maximum value by default. There is no guarantee that results will match from request to request (there may be differences in results sorting).

use_utf8_bom

Parameter that enables the use of byte order mark. The default value is false.

<any field name>

Filtering by the value of one of the available fields. Only the equality check operation is supported.

* Required

Response format

If all available fields are requested:
{
  "data": [
    {
      "application_id": "integer",
      "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",
      "touch_type": "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",
      "ios_ifv": "string",
      "ios_ifa": "string"
    },
    ...
  ]
}
Copied to clipboard
application_id
Unique numeric identifier for the application in AppMetrica.
click_datetime
Date and time of the click/impression in yyyy-mm-dd hh:mm:ss format.
click_id
ID of the click/impression or '' (an empty string if the ID is not available).
click_ipv6
IP address at the time of the click/impression, in IPv6 format. For example, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147
click_timestamp
Time of the click/impression in Unix timestamp format, in seconds.
click_url_parameters
Parameters as they are shown in the URL. Special characters must be escaped (for example, ?param1=1&param2=2... will look like ?param1%3D1%26param2%3D2... in the request).
click_user_agent
User-agent of the click/impression.
publisher_id
ID of the AppMetrica partner. You may use it to identify the publisher in AppMetrica reports. If unattributed postbacks are enabled for the tracker, the field value will be 0.
publisher_name
Name of the AppMetrica partner. If unattributed postbacks are enabled for the tracker, the field value will be empty.
touch_type
Ad interaction type: click | impression.
tracker_name
The name of the tracker added in the AppMetrica interface. If unattributed postbacks are enabled for the tracker, the field value will be empty.
tracking_id
Tracker ID in AppMetrica. You may use it to identify the publisher in AppMetrica reports. If unattributed postbacks are enabled for the tracker, the field value will be 0.
city
The name in English of the city where the click took place.
country_iso_code
ISO country code.
device_type
The device type detected by the AppMetrica service. Possible values: phone | tablet | unknown.
device_model
The device model as detected by the AppMetrica service (for example, Galaxy S6).
device_manufacturer
The device manufacturer as detected by the AppMetrica service (for example, Apple or Samsung).
os_version
Version of the operating system on the user's device.
os_name
Operating system on the user's device: ios | android | windows.
windows_aid
Windows AID of the device in the format received from the device.
google_aid
Google AID device in the format received from the device.
ios_ifv
IFV for the app in the format received from the device.
ios_ifa
IFA of the device in the format received from the device.

Example

Request:
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,click_datetime,click_id,click_ipv6,click_timestamp,click_url_parameters,click_user_agent,publisher_id,publisher_name,tracker_name,tracking_id,touch_type,city,country_iso_code,device_type,device_model,device_manufacturer,os_version,os_name,windows_aid,google_aid,ios_ifv,ios_ifa' \
  -H 'Authorization: OAuth oauth_token'
Copied to clipboard

Response:

{
  "data": [
    {
      "application_id": "1111",
      "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",
      "touch_type": "click",
      "tracker_name": "Аdvertising 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": "",
      "ios_ifv": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "ios_ifa": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
  ]
}
Copied to clipboard