--- metadata: - name: generator content: Diplodoc Platform v5.50.6 alternate: - https://appmetrica.yandex.com.tr/docs/en/mobile-api/logs/ref/profiles.md - https://appmetrica.yandex.com.tr/docs/ru/mobile-api/logs/ref/profiles.md --- > **Documentation Index:** Fetch the complete configuration index at https://appmetrica.yandex.com.tr/docs/en/llms.txt # Profiles Returns information about profiles updated within a specific date range. {% note info %} The latest resource version is `profiles_v2`. The `profiles` resource will soon be removed. Resource version `profiles_v2` now includes new required parameters: `date_since` and `date_until`. {% endnote %} ## Request format {#request-format} ``` GET https://api.appmetrica.yandex.com/logs/v1/export/profiles_v2.{csv | json} ? application_id= & [date_since=] & [date_until=] & fields= & [date_dimension=] & [limit=] & [use_utf8_bom=] & [=] & [version=] & [update_timestamp=] & [skip_unavailable_shards=] ``` #| || `application_id`* | Filtering by the app's numeric ID in AppMetrica || || `date_since`* | Start of the date range in `yyyy-mm-dd hh:mm:ss` format. You can also define the date and time type that affects the data in the `date_dimension` query parameter. || || `date_until`* | End of the date range in `yyyy-mm-dd hh:mm:ss` format. You can also define the date and time type that affects the data in the `date_dimension` query parameter. || || `fields`* | A comma-separated [list of fields](https://appmetrica.yandex.com.tr/docs/en/mobile-api/logs/endpoints.md) for the sample. A list that contains all available fields (for quick copy): ```objectivec translate=no 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 ``` || || `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`. || || `` | Filtering by the value of one of the available fields. Only the equality check operation is supported. || || `version` | Profile version. || || `update_timestamp` | Time of the profile update in [Unix time](https://en.wikipedia.org/wiki/Unix_time) format. || || `skip_unavailable_shards` | Used for [improving data accessibility](https://appmetrica.yandex.com.tr/docs/en/mobile-api/logs/request-procedure.md#availability). The default value is `false`. || |# ## Response format {#response-format} If all available fields are requested: {% list tabs %} - JSON ```json translate=no { "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" }, ... ] } ``` - CSV ``` application_id,ios_ifa,os_name,... 1111,024AE7EB-4128-4237-9803-D24950323D4D,ios,... 1111,3A86D5E8-1985-4A23-B147-5A1C0CF8781E,ios,... 1111,,android ... ``` {% endlist %} #| || `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` | Android device ID. || || `appmetrica_device_id` | A unique device identifier detected by the AppMetrica service. In Android from [AppSetId](https://developer.android.com/identity/app-set-id), in iOS from [IFV](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor). || || `city` | The name of the city 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` | Framework type. Returns one of the following 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 {#example} Request: ```bash translate=no curl -X GET \ 'https://api.appmetrica.yandex.com/logs/v1/export/profiles_v2.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: ```json translate=no { "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. Contact support Suggest an improvement for documentation