Tracking clicks and impressions
Returns data on tracking clicks and impressions for a specific date range.
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>]
|
|
Filtering by the app's numeric ID in AppMetrica |
|
|
Start of the date range in |
|
|
End of the date range in |
|
|
A comma-separated list of fields for the sample. A list that contains all available fields (for quick copy): |
|
|
This parameter defines the point to calculate the date range from:
|
|
|
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). |
|
|
Parameter that enables the use of byte order mark. The default value is |
|
|
Filtering by the value of one of the available fields. Only the equality check operation is supported. |
Response format
If all available fields are requested:
{
"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
...
|
|
Unique numeric identifier for the application in AppMetrica. |
|
|
Type: click or impression. Possible values: |
|
|
Date and time of the click/impression in |
|
|
ID of the click/impression or |
|
|
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. |
|
|
Time of the click/impression in Unix time format, in seconds. |
|
|
Parameters as they are shown in the URL. Special characters must be escaped (for example, |
|
|
User-agent of the click/impression. |
|
|
ID of the AppMetrica publisher. 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. |
|
|
Name of the AppMetrica partner. If unattributed postbacks are enabled for the tracker, the field value will be empty. |
|
|
Name of the tracker being added to the AppMetrica interface If unattributed postbacks are enabled for the tracker, the field value will be empty. |
|
|
ID of the AppMetrica tracker. 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. |
|
|
The name of the city where the click was made (in English). |
|
|
ISO country code. |
|
|
The device manufacturer detected by the AppMetrica service (for example, Apple or Samsung). |
|
|
The device model detected by the AppMetrica service (for example, Galaxy S6). |
|
|
The device type detected by the AppMetrica service. Possible values: |
|
|
The device's Google AID in the format received from the device. |
|
|
The device's Huawei OAID in the format received from the device. |
|
|
The device's IFA in the format received from the device. |
|
|
IFV for the app in the format received from the device. |
|
|
Operating system on the user's device: |
|
|
The version of the operating system on the user's device. |
|
|
The device's Windows AID in the format received from the device. |
|
|
Indicates a non-browser click. |
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,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'
Response:
{
"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"
}
]
}
If you didn't find the answer you were looking for, you can use the feedback form to submit your question. Please describe the problem in as much detail as possible. Attach a screenshot if possible.