Profile attributes
Transmits user parameters.
Usage example: You can send user parameters to the Post API to supplement user profiles and use this data for audience-based segmentation. For example, add an attribute indicating that the user is a loyalty program member.
Event properties can be passed in parameters or in the body of the request. When you pass data in the body, you should add .csv to the URL of the request. For more information, see Sample request.
To bind an event to a user, you should use one of the following fields in the API request:
profile_idappmetrica_device_id
Attention. The Post API has restrictions on loading data. For more information, see Restrictions.
Request format
POST https://api.appmetrica.yandex.ru/logs/v1/import/profiles
? post_api_key=<string>
& application_id=<int>
& profile_id=<string>
& attributes=<>post_api_key * | Token for data uploading. You can get it in the Settings section of your application. |
application_id * | Unique numeric identifier for the application in AppMetrica. |
profile_id * | User profile ID. The Post API allows you only to upload data for identifiers that were previously sent via the SDK. Attention. Do not pass the value with the appmetrica_device_id parameter. The server accepts only one of these parameters. |
attributes * | A set of custom attribute values in {key:value} format. Possible value types: string, number, bool, or counter. If the value of the passed attribute is already written for the profile, it will be overwritten with a new one. Former attribute values will be deleted. Learn more about User profile attributes.Attention. To collect custom profile attributes, add them in the app settings. To do this, open the app page, select Settings, and click Profile attributes. |
post_api_key * | Token for data uploading. You can get it in the Settings section of your application. |
application_id * | Unique numeric identifier for the application in AppMetrica. |
profile_id * | User profile ID. The Post API allows you only to upload data for identifiers that were previously sent via the SDK. Attention. Do not pass the value with the appmetrica_device_id parameter. The server accepts only one of these parameters. |
attributes * | A set of custom attribute values in {key:value} format. Possible value types: string, number, bool, or counter. If the value of the passed attribute is already written for the profile, it will be overwritten with a new one. Former attribute values will be deleted. Learn more about User profile attributes.Attention. To collect custom profile attributes, add them in the app settings. To do this, open the app page, select Settings, and click Profile attributes. |
* Required
Response codes
| Code | Description |
|---|---|
| 200 | Data has been uploaded successfully. |
| 403 | The request omitted an authorization header, or an invalid token was specified. |
| 400 | One or more required parameters were missing in the request. |
| Code | Description |
|---|---|
| 200 | Data has been uploaded successfully. |
| 403 | The request omitted an authorization header, or an invalid token was specified. |
| 400 | One or more required parameters were missing in the request. |
Sample request
POST /logs/v1/import/profiles.csv?post_api_key=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012 HTTP/1.1
Host: api.appmetrica.yandex.com
Content-Length: 540i
Connection: close
application_id,profile_id,attributes
1234567890,1234567890abcdef,"{string_attribute_name:string_value,number_attribute_name:1234,bool_attribute_name:true,counter_attribute_name:-1}"POST /logs/v1/import/profiles.csv?post_api_key=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012&application_id=1234567890&profile_id=1234567890abcdef&attributes="{string_attribute_name:string_value,number_attribute_name:1234,bool_attribute_name:true,counter_attribute_name:-1}" HTTP/1.1
Host: api.appmetrica.yandex.com
Content-Length: 0
Connection: close