Profiles
Returns information about profiles.
Request format
GET https://api.appmetrica.yandex.ru/logs/v1/export/profiles.{csv | json}
? application_id=<int>
& fields=<string>
& [date_dimension=<string>]
& [limit=<string>]
& [use_utf8_bom=<bool>]
& [<any field name>=<string>]
|
|
Filtering by the app's numeric ID in AppMetrica |
|
|
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": [
{
"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"
},
...
]
}
application_id,ios_ifa,os_name,...
1111,024AE7EB-4128-4237-9803-D24950323D4D,ios,...
1111,3A86D5E8-1985-4A23-B147-5A1C0CF8781E,ios,...
1111,,android
...
|
|
User profile ID. |
|
|
Gender. |
|
|
Age. |
|
|
Notifications are enabled. |
|
|
Name. |
|
|
Number of crashes. |
|
|
Number of errors. |
|
|
Date of the first session. |
|
|
Date when the app was last launched. |
|
|
Number of opened push notifications. |
|
|
Number of sent push notifications. |
|
|
Version of the AppMetrica SDK. |
|
|
Number of sessions. |
|
|
Android device ID. |
|
|
A unique device identifier detected by the AppMetrica service. |
|
|
The name of the city where the click was made (in English). |
|
|
Type of connection. Possible values: |
|
|
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 IFA in the format received from the device. |
|
|
IFV for the app in the format received from the device. |
|
|
Mobile country code. |
|
|
Mobile network code. |
|
|
Name of the mobile operator. |
|
|
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. |
|
|
App build number. |
|
|
Framework type. Returns one of the following values:
|
|
|
The package name for Android, or the Bundle ID for iOS (for example, ru.yandex.metro). |
|
|
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'
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": "android_id__example",
"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": "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",
"windows_aid": "windows_aid__example",
"app_build_number": "1",
"app_framework": "0",
"app_package_name": "ru.yandex.metro",
"app_version_name": "1.0"
}
]
}
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.