Uploading information about calls

Uploads information about calls. In the example, data is passed in the request body as multipart/form-data.

Tip. Create a CSV file with the data and send 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. It can take up to 24 hours to process the data.
  1. Request syntax
  2. In the request body
  3. Response format
  4. What's next?

Request syntax

counterId: ID of the tag for which you want to upload information about calls.

POST https://api-metrika.yandex.net/management/v1/counter/{counterId}/offline_conversions/upload_calls
 ? client_id_type=<offline_conversion_uploading_client_id_type>
 & [comment=<string>]
 & [new_goal_name=<string>]
client_id_type *Type of user IDs.

Acceptable values:

  • client_id: Site user ID assigned by Yandex Metrica.
  • user_id: Site user ID assigned by the site owner.
  • YCLID: The ID of a click on a Yandex Direct ad assigned by Yandex Direct.
commentComment.
new_goal_nameName of a new goal for calls if this goal doesn't exist yet. If the goal exists, this parameter is ignored.
client_id_type *Type of user IDs.

Acceptable values:

  • client_id: Site user ID assigned by Yandex Metrica.
  • user_id: Site user ID assigned by the site owner.
  • YCLID: The ID of a click on a Yandex Direct ad assigned by Yandex Direct.
commentComment.
new_goal_nameName of a new goal for calls if this goal doesn't exist yet. If the goal exists, this parameter is ignored.

* Required

In the request body


POST https://api-metrika.yandex.net/management/v1/counter/{counterId}/offline_conversions/upload_calls
Content-Type: multipart/form-data; boundary=------------------------7zDUQOAIAE9hEWoV
Context-Length: 643

--------------------------7zDUQOAIAE9hEWoV
Content-Disposition: form-data; name="file"; filename="data.csv"
Content-Type: text/csv

ClientId,DateTime,Price,Currency,PhoneNumber,TalkDuration,HoldDuration,CallMissed,Tag,FirstTimeCaller,URL,CallTrackerURL
133591247640966458,1481714026,678.90,RUB,+71234567890,136,17,0,,1,https://test.com/,https://test.com/
579124169844706072,1481718066,123.45,RUB,+70987654321,17,23,0,,2,https://test.com/,https://test.com/
148059425477661429,1481718126,678.90,RUB,+71234509876,72,11,0,,0,https://test.com/,https://test.com/
--------------------------7zDUQOAIAE9hEWoV--

Sample request

POST https://api-metrika.yandex.net/management/v1/counter/{counterId}/offline_conversions/upload_calls?client_id_type=USER_ID

Response format


{
    "uploading" :  < uploading > 
}
Parameters Description
uploading Information about an upload of offline conversions.
Parameters Description
uploading Information about an upload of offline conversions.

What's next?

To track a call upload status, use the GET /management/v1/counter/{counterId}/offline_conversions/calls_uploading/{id} method.