Profiles

Returns information about profiles.

  1. Request format
  2. Response format
  3. Example

Request format

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

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
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": [
    {
      "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"
    },
    ...
  ]
}
Copied to clipboard
profile_id
User profile ID.
appmetrica_gender
Gender.
appmetrica_birth_date
Age.
appmetrica_notifications_enabled
Notifications are enabled.
appmetrica_name
Name.
appmetrica_crashes
Number of crashes.
appmetrica_errors
Number of errors.
appmetrica_first_session_date
Date of the first session.
appmetrica_last_start_date
Date when the app was last launched.
appmetrica_push_opens
Number of opened push notifications.
appmetrica_push_send_count
Number of sent push notifications.
appmetrica_sdk_version
Version of the AppMetrica SDK.
appmetrica_sessions
Number of sessions.
android_id
The Android device ID.
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_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.
windows_aid
The device's Windows AID in the format received from the device.
app_build_number
App build number.
app_framework

Type of framework.

Returns one of the following possible values:
  • "0" — Native.
  • "1" — Unity.
  • "2" — Xamarin.
  • "3" — React.
  • "4" — Cordova.
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.

Example

Request:
curl -X GET \
  'https://api.appmetrica.yandex.ru/logs/v1/export/profiles.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'
Copied to clipboard

Response:

{
  "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": "",
      "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": "",
      "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": "",
      "app_build_number": "1",
      "app_framework": "0",
      "app_package_name": "ru.yandex.metro",
      "app_version_name": "1.0"
    }
  ]
}
Copied to clipboard