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>]
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):
|
date_dimension | The parameter defines what date and time are used as a condition for getting into the data sample:
|
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 |
<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 |
fields * | A comma-separated list of fields for the sample. A list that contains all available fields (for quick copy):
|
date_dimension | The parameter defines what date and time are used as a condition for getting into the data sample:
|
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 |
<any field name> | Filtering by the value of one of the available fields. Only the equality check operation is supported. |
* Required
Response format
{ "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
application_id,ios_ifa,os_name,...
1111,024AE7EB-4128-4237-9803-D24950323D4D,ios,...
1111,3A86D5E8-1985-4A23-B147-5A1C0CF8781E,ios,...
1111,,android
...
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
wifi
| cell
| unknown
.country_iso_code
device_manufacturer
device_model
device_type
phone
| tablet
| unknown
.google_aid
ios_ifa
ios_ifv
mcc
mnc
operator_name
os_name
ios
| android
| windows
.os_version
windows_aid
app_build_number
app_framework
Type of framework.
- "0" — Native.
- "1" — Unity.
- "2" — Xamarin.
- "3" — React.
- "4" — Cordova.
app_package_name
app_version_name
Example
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