userParams

Warning

Working with the JavaScript API requires knowledge of HTML and JavaScript. If you don’t know these languages, contact your website developer or webmaster.

Transmitting custom parameters of site users.

ym(XXXXXX, 'userParams', parameters);

Parameter

Default value

Type

Description

parameters*

:

Object

User parameters.

ym(XXXXXX, 'userParams', {
    status: "Gold",
    child: 1,
    child_age: 13,
    UserID: 12345 
}); 

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

up to 512 parameters can be sent in one session. When you send hierarchically structured data, the Yandex Metrica reports display up to 10 nesting levels. For more information, see Restrictions.

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

The maximum number of characters shown in Yandex Metrica reports:

  • In fields — 255.
  • In values — 50.

Chat with us

Write an email

Please note: Our support team will never initiate a call to you. Do not follow any instructions of people who call you and introduce themselves as the Yandex Metrica support team.


Required parameter.