Uploading parameters

Uploads parameters.

Request

POST

https://api-metrika.yandex.net/management/v1/counter/{counterId}/user_params/uploadings/upload

Path parameters

Name

Description

counterId

Type: integer

ID of the counter for which you want to upload parameters.

Query parameters

Name

Description

action

Type: string

Type of action that you want to perform. Action to be performed:

update: Add parameters.
delete_keys: Delete parameters.

Example: update

Body

multipart/form-data

{
  "file": "example"
}

Name

Description

file

Type: string<binary>

Parameters to upload, which are passed as multipart/form-data.

Example: example

Responses

200 OK

Body

application/json

{
  "uploading": {
    "id": 0,
    "create_time": "2025-01-01T00:00:00Z",
    "line_quantity": 0,
    "linked_quantity": 0,
    "comment": "example",
    "content_id_type": "example",
    "action": "example",
    "status": "example",
    "linked_percentage": "example"
  }
}

Name

Description

uploading

Type: UserParamsUploading

Information about the uploaded user parameters.

Example

{
  "id": 0,
  "create_time": "2025-01-01T00:00:00Z",
  "line_quantity": 0,
  "linked_quantity": 0,
  "comment": "example",
  "content_id_type": "example",
  "action": "example",
  "status": "example",
  "linked_percentage": "example"
}

UserParamsUploading

Information about the uploaded user parameters.

Name	Description
action	Type: string Action to be performed: `update`: Add parameters. `delete_keys`: Delete parameters. Example: `example`
comment	Type: string Custom comment. The maximum number of characters is 255. Min length: `0` Max length: `255` Example: `example`
content_id_type	Type: string Type of user IDs: `USER_ID`: site user id assigned by the site owner. `CLIENT_ID`: Site user ID assigned by Yandex Metrica. Example: `example`
create_time	Type: string<date-time> Upload time. Example: `2025-01-01T00:00:00Z`
id	Type: integer Upload ID.
line_quantity	Type: integer Number of rows that passed validation during upload.
status	Type: string Upload status: `is_processed`: Reports that the parameters have been uploaded, after the upload confirmation. `processed`: Reports that the delivered data has been processed successfully. `linkage_failure`: Reports that none of the delivered IDs were linked to site users during the upload. Example: `example`

Example

{
  "id": 0,
  "create_time": "2025-01-01T00:00:00Z",
  "line_quantity": 0,
  "comment": "example",
  "content_id_type": "example",
  "action": "example",
  "status": "example"
}

Was the article helpful?

Information about a parameter upload

Confirming a parameter upload