Uploading information about calls

Uploads information about calls.

Data is passed as multipart/form-data in CSV format. The first line of the request must pass the column names.

Required columns:

  • UserId — The site user ID assigned by the site owner (only for client_id_type = USER_ID).
  • ClientId — The site visitor ID assigned by Yandex.Metric (only for client_id_type = CLIENT_ID).
  • Yclid — The ID of a click on a Yandex.Direct ad assigned by Yandex.Direct (only for client_id_type = YCLID).
  • DateTime — Date and time of conversion in unix timestamp.

Optional columns:

  • StaticCall — Whether the call is static (1 — static, 0 — dynamic).
  • Price — The cost of the goal, using a dot (.) as the decimal separator.
  • Currency — The currency using the three-letter code from the ISO 4217 standard.
  • PhoneNumber — The phone number (with the country and city code) without spaces. For example: +79451234567.
  • TalkDuration — The duration of the call in seconds.
  • HoldDuration — The amount of time spent waiting for the call in seconds.
  • CallMissed — Whether the call was missed (1 — missed, 0 — answered).
  • Tag — Custom tag label. Can be used to mark the quality of the call or result. For example: «The customer was not satisfied with the price».
  • FirstTimeCaller — First call (1 — first call, 0 — repeat call).
  • URL —Source URL for the call (associated with a page event). For example, this may be a landing page for an advertising campaign with a phone number (PhoneNumber).
  • CallTrackerURL — URL to the call tracker interface.
  1. Request syntax
  2. Request message body
  3. Response format

Request syntax

counterId — ID of the tag that you want to upload information about calls for.

https://api-metrica.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>]
Query-параметры
client_id_typeType of user identifiers.

Allowed values:

  • USER_ID — Site user ID assigned by 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.
commentComments.
new_goal_nameThe name of a new target for calls if this target doesn't exist. If it exists, the parameter is ignored.

Request message body


POST http://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--

Request example

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

Response format


{
    "uploading" :  < uploading > 
}
Parameters Description
uploading Information about the upload of calls.