Transmitting data

Yandex.Metrica assigns each site user a ClientID. At the same time, you might be using your own system for identifying users. In Yandex.Metrica, the user identifier given by the owner of the site is called the UserID.

There are several ways you can send user parameters to Yandex.Metrica:

During a site session.
Using a CSV file at any time.

Data on user parameters will be available in reports within a few hours. To view statistics, use the User parameters report. You can also use this data to create segments for retargeting lists in Yandex.Direct or Yandex.Audience (see the example).

Note. When transmitting user parameters specifying the ClientID and UserID, the total number of users in Yandex.Metrica reports may differ from the number of IDs passed due to the way the UserID is bound to the ClientID.

During a site session

This method is useful when you are generating a report based on data received while the user is viewing the site.

User parameters are transmitted to Yandex.Metrica through the JavaScript API. Information sent using this method cannot be deleted from Yandex.Metrica.

To transmit parameters at any other time, use the userParams method. To transmit parameters during tag initialization, specify data in the userParams parameter. The information is transmitted as a JavaScript object and processed as follows.

The field name and nesting level are interpreted as the parameter name and level, respectively. The field value is processed as follows, depending on its type:

object — A tree branch is created for each object key, and the algorithm is called recursively for each value.
string — Counts the number of times each different value of the string occurs.
number — Calculates the total and average value of all numbers.
true, false or null — Calculates the number of times each value occurs.

To transmit your own user ID, use the UserID parameter. You can choose any names for other user parameters.

Up to 1000 parameters can be transmitted in a single session. When the hierarchical data structure is transmitted, the Yandex.Metrica reports will display up to 10 nesting levels.

Data will be bound to ClientID only if the userParams method was called during the user's session. To get more complete statistics, wait until a larger volume of data has been transmitted to Yandex.Metrica.

Information passed in the userParams method will be available in reports within a few hours.

Let's look at an online store that has two types of customers: “normal” and “VIP”. The client status data is stored in the site's own database. After users sign in on the site, they see their usernames in place of the Sign in link on every page. If a user has a special status, it is shown next to the name: Jane / VIP. Along with the status, you can also transmit the user ID that is stored in your database.

To send data to Yandex.Metrica, add code to all the site's pages that will call the userParams method.

For sending data about users with a special status, the code will look like this:

ym(XXXXXX, 'userParams', {
    vip_status: true,
    child: 1,
    child_age: 13,
    UserID: 12345
});

ym(XXXXXX, 'init', {
    clickmap: true,
    webvisor: true,
    userParams: {
        vip_status: true,
        child: 1,
        child_age: 13,
        UserID: 12345
    }
});

If information is being transmitted about a “normal” user, the code will look like this:

ym(XXXXXX, 'userParams', {
    vip_status: false,
    child: 1,
    child_age: 13,
    UserID: 12345
});

ym(XXXXXX, 'init', {
    clickmap: true,
    webvisor: true,
    userParams: {
        vip_status: false,
        child: 1,
        child_age: 13,
        UserID: 12345
    }
});

where XXXXXX is your tag ID.

If a “normal” customer gets VIP status, the userParams method sends the new data to Yandex.Metrica the next time this user signs in on the site. This new status will apply to the entire history of this user's sessions, as if the customer was always VIP.

Transmitting data in a CSV file at any time

This method allows you to send Yandex.Metrica not only the data collected during the site session, but also any data collected after the user left the site.

Specification for the CSV format

Overview of the CSV format

Required fields for transmitting data
Field name	Description	Example
`clientID` \| `userID`	Site user ID	P12345
`key`	User ID. Maximum of 1,000 per user	age \| client.age
`value`	User ID value	40

For a hierarchical structure of parameters, use the dot (“.”). For example, to transmit multiple values of the key field, specify client.demography.age.

The maximum number of characters in fields shown in Yandex.Metrica reports:

key — 255
value — 50

When to transmit the ClientID

We recommend using the ClientID in transmitted data if you don't need to get your own IDs in a report. In this case, to transmit the data:

Use the getClientID method to get the ClientID.
Prepare a CSV file specifying the ClientID and send it through the Yandex.Metrica interface.

When to transmit the UserID

We recommend using the UserID if, for instance, your site already has a user ID system and you need to get a report that shows these IDs. In this case, you need to create a CSV file specifying the UserIDs and send it through the Yandex.Metrica interface.

Working with a file

The Yandex.Metrica interface lets you upload data and delete it. You can work with a file in the Settings section (on the Upload data tab, go to the section Upload user parameters).

Uploading data

To send a prepared CSV file to Yandex.Metrica:

Click Upload data.
In the window that opens, choose the file type according to the type of ID you want to upload (UserID or ClientID).
Select the file on your computer and add comments to the upload, if necessary.
Click Upload data.

Sample CSV file for uploading data

Deleting data

To remove previously uploaded data or parts of it from the service, prepare a CSV file. The file should only contain the key field for the data you want to remove. Then follow these steps:

Click Delete data.
In the window that opens, choose the type of file to apply the changes to, according to the type of ID (UserID or ClientID).
Select the file on your computer and add comments to the upload, if necessary.
Click Upload data.

Sample CSV file for deleting data

It takes some time for the service to process the file. When processing is complete, the information you sent will be available in the User parameters report. You can also use this data to create segments for retargeting lists in Yandex.Direct or Yandex.Audience (see the example).