Passing offline conversions

Step 1. Preparing data

1. Prepare special IDs: ClientID, UserID, or yclid.
2. Create a JavaScript event goal using the POST /management/v1/counter/{counterId}/goals method. For the goal ID, specify the event to track (for example, order confirmation: “order_confirmed”). You will need this ID when creating a CSV file.

   Note. When creating a “JavaScript event” goal, make sure to use the “matches” condition.

   You can use a previously created goal if conversions for this goal are done both on the website and offline and you want to get general statistics.

Step 2. Checking that Yandex Metrica is ready to process conversions

You can attribute conversion to a session tracked by Yandex Metrica within 21 days. The conversion tracking period gradually increases after enabling the option. Therefore, conversions can be transmitted for a time period equal to the accounting period. You can upload conversions in about a day after enabling the option.

To check whether you can upload data and for what period, use the GET /management/v1/counter/{counterId}/offline_conversions/visit_join_threshold method.

Step 3. Preparing the CSV file

Step 4. Transmitting data

Use the method POST /management/v1/counter/{counterId}/offline_conversions/upload. In the input data, specify the OAuth token, tag ID, and user ID type.

$counter = "";            // Specify the tag ID
$token = "";              // Specify the OAuth token
$client_id_type = "";     // Specify the type of user IDs – CLIENT_ID, USER_ID, or YCLID

$curl = curl_init("https://api-metrika.yandex.ru/management/v1/counter/$counter/offline_conversions/upload?client_id_type=$client_id_type");

curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, array('file' => new CurlFile(realpath('file.csv'))));
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array("Content-Type: multipart/form-data", "Authorization: OAuth $token"));

$result = curl_exec($curl);

echo $result;

curl_close($curl);

import requests

counter = 123456
token = "token"

file = open("offline-conversions.csv", "r").read()
id_type = "CLIENT_ID"

url = "https://api-metrika.yandex.net/management/v1/counter/{}/offline_conversions/upload?client_id_type={}".format(counter, id_type)
headers = {
 "Authorization": "OAuth {}".format(token)
}

req = requests.post(url, headers=headers, files={"file":file})

What's next?

To track the status of conversion upload, use the GET /management/v1/counter/{counterId}/offline_conversions/uploading/{id} method.