Push tokens

Returns data about push tokens.

Request format

GET https://api.appmetrica.yandex.ru/logs/v1/export/push_tokens.{csv | json}
  ? application_id=<int>
  & fields=<string>
  & [date_dimension=<string>]
  & [limit=<string>]
  & [use_utf8_bom=<bool>]
  & [<any field name>=<string>]

application_id*

Filtering by the app's numeric ID in AppMetrica

fields*

A comma-separated list of fields for the sample.

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

token,token_datetime,token_receive_datetime,token_receive_timestamp,token_timestamp,appmetrica_device_id,city,connection_type,country_iso_code,device_ipv6,device_locale,device_manufacturer,device_model,device_type,google_aid,ios_ifa,ios_ifv,mcc,mnc,operator_name,os_name,os_version,profile_id,windows_aid,app_package_name,app_version_name,application_id

date_dimension

This parameter defines the point to calculate the date range from:

  • default: When the event occurred on the device.
  • receive: When the server received information about the event.

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.

Response format

If all available fields are requested:

{
  "data": [
    {
      "token": "string",
      "token_datetime": "string",
      "token_receive_datetime": "string",
      "token_receive_timestamp": "integer",
      "token_timestamp": "integer",
      "appmetrica_device_id": "integer",
      "city": "string",
      "connection_type": "string",
      "country_iso_code": "string",
      "device_ipv6": "string",
      "device_locale": "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",
      "profile_id": "string",
      "windows_aid": "string",
      "app_package_name": "string",
      "app_version_name": "string",
      "application_id": "integer"
    },
    ...
  ]
}
application_id,ios_ifa,os_name,...
1111,024AE7EB-4128-4237-9803-D24950323D4D,ios,...
1111,3A86D5E8-1985-4A23-B147-5A1C0CF8781E,ios,...
1111,,android
...

token

Push token value.

token_datetime

Time of token creation in yyyy-mm-dd hh:mm:ss format.

token_receive_datetime

Time when the token was received on the server side in yyyy-mm-dd hh:mm:ss format. It may differ from token_datetime due to network delays or problems with the user's internet connection.

token_receive_timestamp

Time when the token was received on the server side in Unix time format. It may differ from token_datetime due to network delays or problems with the user's internet connection.

token_timestamp

Time of token creation in Unix time format.

appmetrica_device_id

A unique device identifier detected by the AppMetrica service.

city

The name of the city where the click was made (in English).

connection_type

Type of connection. Possible values: wifi | cell | unknown.

country_iso_code

ISO country code.

device_ipv6

The IP address at the time of the event in IPv6 format. For example, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147.

device_locale

The language on the device.

device_manufacturer

The device manufacturer detected by the AppMetrica service (for example, Apple or Samsung).

device_model

The device model detected by the AppMetrica service (for example, Galaxy S6).

device_type

The device type detected by the AppMetrica service. Possible values: phone | tablet | unknown.

google_aid

The device's Google AID in the format received from the device.

ios_ifa

The device's IFA in the format received from the device.

ios_ifv

IFV for the app in the format received from the device.

mcc

Mobile country code.

mnc

Mobile network code.

operator_name

Name of the mobile operator.

os_name

Operating system on the user's device: ios | android | windows.

os_version

The version of the operating system on the user's device.

profile_id

User profile ID.

windows_aid

The device's Windows AID in the format received from the device.

app_package_name

The package name for Android, or the Bundle ID for iOS (for example, ru.yandex.metro).

app_version_name

The app version in the format specified by the developer.

application_id

Unique numeric identifier for the application in AppMetrica.

Example

Request:

curl -X GET \
  'https://api.appmetrica.yandex.ru/logs/v1/export/push_tokens.json?application_id=1111&fields=token,token_datetime,token_receive_datetime,token_receive_timestamp,token_timestamp,appmetrica_device_id,city,connection_type,country_iso_code,device_ipv6,device_locale,device_manufacturer,device_model,device_type,google_aid,ios_ifa,ios_ifv,mcc,mnc,operator_name,os_name,os_version,profile_id,windows_aid,app_package_name,app_version_name,application_id' \
  -H 'Authorization: OAuth oauth_token'

Response:

{
  "data": [
    {
      "token": "eWA7ZVw0cfg:APA91b...",
      "token_datetime": "yyyy-mm-dd hh:mm:ss",
      "token_receive_datetime": "yyyy-mm-dd hh:mm:ss",
      "token_receive_timestamp": "1556258667",
      "token_timestamp": "1556258660",
      "appmetrica_device_id": "123456789012345678",
      "city": "Moscow",
      "connection_type": "wifi",
      "country_iso_code": "RU",
      "device_ipv6": "::ffff:5.255.232.147",
      "device_locale": "ru_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",
      "profile_id": "test",
      "windows_aid": "windows_aid__example",
      "app_package_name": "ru.yandex.metro",
      "app_version_name": "1.0",
      "application_id": "1111"
    }
  ]
}

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.

Contact support