Uploading information about calls

Uploads information about calls.

Tip

Create a CSV file with the data and pass it using this method. We also recommend generating API requests automatically using modules written in a programming language.

To learn about which data to transmit and to view a sample request, see Passing offline conversions.

Note

Data processing can take up to two hours after upload.

Request

POST

https://api-metrica.yandex.net/management/v1/counter/{counterId}/offline_conversions/upload_calls

Path parameters

Name

Description

counterId*

Type: integer<int32>

ID of the counter for which you want to upload information about calls.
Example: 2215573

Query parameters

Name

Description

comment

Type: string

Comment.

new_goal_name

Type: string

Name of a new goal for calls if this goal doesn't exist yet. If the goal exists, this parameter is ignored.
Example: Call

Body

multipart/form-data

{
    "file": null
}

Name

Description

file*

Type: string<binary>

Call information to upload, which is passed as multipart/form-data.

Responses

200 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",
        "static_calls_quantity": 0,
        "dynamic_calls_quantity": 0
    }
}

Name

Description

uploading*

Type: OfflineCallsUploading

Information about call uploads.

OfflineCallsUploading

Information about call uploads.

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`: ID of a click on a Yandex Direct ad assigned by Yandex Direct. Example: `USER_ID`
comment	Type: string Arbitrary comment. The maximum number of characters is 255. Min length: `0` Max length: `255`
create_time	Type: string<date-time> Upload time.
dynamic_calls_quantity	Type: integer<int32> Number of dynamic calls.
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.
static_calls_quantity	Type: integer<int32> Number of static calls.
status	Type: string Upload status: `PREPARED`: Upload prepared. `UPLOADED`: Upload complete. `EXPORTED`: Upload exported. `MATCHED`: Event IDs have been matched. `PROCESSED`: Upload processed successfully. `LINKAGE_FAILURE`: Couldn't find a matching user ID. If you pass information about static calls, they won't be linked to sessions in Yandex Metrica — but they will be included in call reports.

Was the article helpful?

Passing call data

List of uploads of call information