Information about a parameter upload

Returns information about the specified upload of parameters.

Request

GET

https://api-metrica.yandex.net/management/v1/counter/{counterId}/user_params/uploading/{uploadingId}

Path parameters

Name

Description

counterId*

Type: integer<int32>

Counter ID.
Example: 2215573

uploadingId*

Type: integer<int32>

ID of the parameter upload you want to get information about.
Example: 42

Responses

200 OK

OK

Body

application/json
{
    "uploading": {
        "id": 0,
        "create_time": "2022-12-29T18:02:01Z",
        "line_quantity": 0,
        "comment": "string",
        "content_id_type": "string",
        "action": "string",
        "status": "string"
    }
}

Name

Description

uploading*

Type: UserParamsUploading

Information about the uploaded user parameters.

UserParamsUploading

Information about the uploaded user parameters.

Name

Description

action

Type: string

Action to be performed:

  • update: Add parameters.
  • delete_keys: Delete parameters.

comment

Type: string

Arbitrary comment. The maximum number of characters is 255.

Min length: 0

Max length: 255

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.

create_time

Type: string<date-time>

Upload time.

id

Type: integer<int64>

Upload ID.

line_quantity

Type: integer<int32>

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.