Information about an upload of offline conversions

Returns information about the specified upload of offline conversions.

Request

GET

https://api-metrika.yandex.net/management/v1/counter/{counterId}/offline_conversions/uploading/{id}

Path parameters

Name

Description

counterId*

Type: integer<int32>

ID of the counter for which you want to get information about offline conversion uploads.
Example: 2215573

id*

Type: integer<int64>

ID of the upload whose details you want to get. You can see the ID when you upload data on offline conversions.
Example: 12

Responses

200 OK

OK

Body

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

Name

Description

uploading*

Type: OfflineConversionUploading

Information about an upload of offline conversions.

OfflineConversionUploading

Information about an upload of offline conversions.

Name

Description

client_id_type

Type: string

Type of user IDs. Possible values:

  • user_id: Site user ID assigned by the site owner.
  • client_id: Site user ID assigned by Yandex Metrica.
  • YCLID: The ID of a click on a Yandex Direct ad assigned by Yandex Direct.

Example: USER_ID

comment

Type: string

Custom comment. The maximum number of characters is 255.

Min length: 0

Max length: 255

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.

source_quantity

Type: integer<int32>

Number of rows in the source file.

status

Type: string

Upload status:

  • PREPARED: Upload prepared.
  • UPLOADED: Upload complete.
  • EXPORTED: Upload exported.
  • MATCHED: Event IDs matched.
  • PROCESSED: Upload processed.
  • LINKAGE_FAILURE: Couldn't find a matching user ID. If you send data on static calls, they won't be attributed to sessions in Yandex Metrica, but they will appear in your call reports.

No longer supported, please use an alternative and newer version.