Яндекс Метрика

https://yandex.ru/support/metrica/ru/
Admin
Яндекс Метрика — это инструмент веб-аналитики, который помогает получать наглядные отчеты, записи...
Tokens:4,190
Snippets:20
Trust Score:9.9
Update:7 months ago
Show doc for...
Tokens:
Raw
### Passing Visit and Visitor Parameters

Source: https://yandex.ru/support/metrica/ru/code/counter-spa-setup

Allows you to pass custom parameters for visits and visitors to Yandex Metrica.

```APIDOC
## POST /params and /userParams

### Description
Allows you to pass custom parameters for visits and visitors to Yandex Metrica.

### Method
POST

### Endpoint
`/params` (for visit parameters) or `/userParams` (for visitor parameters)

### Parameters
#### Path Parameters
- **counterId** (integer) - Required - The ID of your Yandex Metrica counter.

#### Request Body
- **parameters** (object) - Required - An object containing key-value pairs of parameters to send.
  - **param1** (string) - Example parameter value.

### Request Example
```json
{
  "counterId": XXXXXX,
  "parameters": {
    "param1": "param_value1"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the parameter update.

#### Response Example
```json
{
  "status": "parameters_updated"
}
```
```

--------------------------------

### Manual Page View Tracking (hit function)

Source: https://yandex.ru/support/metrica/ru/code/counter-spa-setup

Manually tracks a page view. This function should be used when `defer: true` is set during initialization to record page impressions at specific points in the SPA's lifecycle.

```APIDOC
## POST /hit

### Description
Manually tracks a page view. This function should be used when `defer: true` is set during initialization to record page impressions at specific points in the SPA's lifecycle.

### Method
POST

### Endpoint
`/hit`

### Parameters
#### Path Parameters
- **counterId** (integer) - Required - The ID of your Yandex Metrica counter.

#### Request Body
- **url** (string) - Optional - The URL of the page to track. Defaults to `window.location.href` if not provided.
- **options** (object) - Optional - Additional options for tracking.
  - **callback** (function) - Optional - A callback function to be executed after data is sent.
  - **ctx** (object) - Optional - Context available in the callback function.
  - **params** (object) - Optional - Visit parameters.
    - **order_price** (double) - Optional - The price of the goal. Can be in currency or abstract units.
    - **currency** (string) - Optional - The currency code (ISO 4217) for the `order_price`.
  - **referer** (string) - Optional - The URL from which the current page was loaded.
  - **title** (string) - Optional - The title of the current page. Defaults to `document.title`.

### Request Example
```json
{
  "counterId": XXXXXX,
  "url": "#contacts",
  "options": {
    "params": {
      "title": "Контактная информация",
      "referer": "http://example.com/#main"
    }
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the hit tracking.

#### Response Example
```json
{
  "status": "hit_recorded"
}
```
```

--------------------------------

### Send E-commerce Data with `dataLayer`

Source: https://yandex.ru/support/metrica/ru/code/counter-spa-setup

Demonstrates how to send e-commerce data to Yandex Metrica using the `dataLayer.push` method. This includes purchase details such as transaction ID, product information, price, brand, category, and quantity. A `hit` function call is required on page transitions for accurate data collection.

```javascript
dataLayer.push({
    "ecommerce": {
        "purchase": {
            "actionField": {
                "id": "TRX987"
            },
            "products": [
                {
                    "id": "25341",
                    "name": "Толстовка Яндекс мужская",
                    "price": 1345.26,
                    "brand": "Яндекс / Яndex",
                    "category": "Одежда/Мужская одежда/Толстовки и свитшоты",
                    "variant": "Оранжевый цвет"
                },
                {
                    "id": "25314",
                    "name": "Толстовка Яндекс женская",
                    "price": 1543.62,
                    "brand": "Яндекс / Яndex",
                    "category": "Одежда/Женская одежда/Толстовки и свитшоты",
                    "variant": "Белый цвет",
                    "quantity": 3
                }
            ]
        }
    }
});
```

--------------------------------

### Counter Initialization for SPAs

Source: https://yandex.ru/support/metrica/ru/code/counter-spa-setup

Initializes the Yandex Metrica counter for SPA websites. Setting `defer: true` disables automatic page view tracking, allowing manual tracking via the `hit` function.

```APIDOC
## POST /init

### Description
Initializes the Yandex Metrica counter for SPA websites. Setting `defer: true` disables automatic page view tracking, allowing manual tracking via the `hit` function.

### Method
POST

### Endpoint
`/init`

### Parameters
#### Request Body
- **counterId** (integer) - Required - The ID of your Yandex Metrica counter.
- **options** (object) - Optional - Configuration options for the counter.
  - **defer** (boolean) - Optional - If true, disables automatic page view tracking.
  - **clickmap** (boolean) - Optional - Enables click map tracking.
  - **trackLinks** (boolean) - Optional - Enables tracking of outbound links.
  - **accurateTrackBounce** (boolean) - Optional - Enables more accurate bounce rate tracking.

### Request Example
```json
{
  "counterId": XXXXXX,
  "options": {
    "defer": true,
    "clickmap": true,
    "trackLinks": true,
    "accurateTrackBounce": true
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the initialization.

#### Response Example
```json
{
  "status": "initialized"
}
```
```

--------------------------------

### Pass Visit and Visitor Parameters

Source: https://yandex.ru/support/metrica/ru/code/counter-spa-setup

Allows for passing custom parameters related to visits or visitors to Yandex Metrica. The `params` function is used for visit-specific data, while `userParams` is for data that persists across visits for a particular user.

```javascript
ym(XXXXXX, 'params', {param1: 'param_value1'});
```

```javascript
ym(XXXXXX, 'userParams', {param1: 'param_value1'});
```

--------------------------------

### Manually Track Page Views with `hit` Function

Source: https://yandex.ru/support/metrica/ru/code/counter-spa-setup

Manually sends a page view to Yandex Metrica using the `hit` function. This is essential for SPAs when `defer: true` is set during initialization. It allows for custom URL, title, referer, and visit parameters to be sent with each view.

```javascript
ym(XXXXXX, 'hit', url[, options]);
```

```javascript
ym(XXXXXX, 'init', {});
//...
ym(XXXXXX, 'hit', '#contacts', {
    params:{
        title: 'Контактная информация',
        referer: 'http://example.com/#main'
    }
});
```

--------------------------------

### Goal Achievement Tracking (reachGoal function)

Source: https://yandex.ru/support/metrica/ru/code/counter-spa-setup

Tracks the achievement of a specific goal. This is useful for events that occur without a change in the page URL.

```APIDOC
## POST /reachGoal

### Description
Tracks the achievement of a specific goal. This is useful for events that occur without a change in the page URL.

### Method
POST

### Endpoint
`/reachGoal`

### Parameters
#### Path Parameters
- **counterId** (integer) - Required - The ID of your Yandex Metrica counter.

#### Request Body
- **goalName** (string) - Required - The name of the goal to track.

### Request Example
```json
{
  "counterId": XXXXXX,
  "goalName": "TARGET_NAME"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the goal tracking.

#### Response Example
```json
{
  "status": "goal_achieved"
}
```
```

--------------------------------

### Initialize Yandex Metrica Counter for SPA

Source: https://yandex.ru/support/metrica/ru/code/counter-spa-setup

Initializes the Yandex Metrica counter for Single Page Applications (SPAs) with deferred loading enabled. This prevents automatic page view tracking, allowing manual control via the `hit` function. It also enables click maps and accurate bounce rate tracking.

```javascript
ym(XXXXXX, 'init', {
    defer: true,
    clickmap:true,
    trackLinks:true,
    accurateTrackBounce:true
});
```

--------------------------------

### Track Goal Achievement with `reachGoal`

Source: https://yandex.ru/support/metrica/ru/code/counter-spa-setup

Sends a goal achievement event to Yandex Metrica using the `reachGoal` function. This is used to track specific user actions or conversions on the website, especially when the page URL does not change.

```javascript
ym(XXXXXX, 'reachGoal', 'TARGET_NAME);
```

--------------------------------

### Ecommerce Data Transmission

Source: https://yandex.ru/support/metrica/ru/code/counter-spa-setup

Enables the transmission of e-commerce data to Yandex Metrica. Requires the `hit` function to be called on page transitions.

```APIDOC
## POST /ecommerce/purchase

### Description
Enables the transmission of e-commerce data to Yandex Metrica. Requires the `hit` function to be called on page transitions.

### Method
POST

### Endpoint
`/ecommerce/purchase`

### Parameters
#### Path Parameters
- **counterId** (integer) - Required - The ID of your Yandex Metrica counter.

#### Request Body
- **ecommerceData** (object) - Required - An object containing e-commerce data.
  - **purchase** (object) - Details of the purchase.
    - **actionField** (object) - Information about the purchase action.
      - **id** (string) - Required - The transaction ID.
    - **products** (array) - An array of product objects.
      - **id** (string) - Required - Product ID.
      - **name** (string) - Required - Product name.
      - **price** (double) - Required - Product price.
      - **brand** (string) - Optional - Product brand.
      - **category** (string) - Optional - Product category.
      - **variant** (string) - Optional - Product variant.
      - **quantity** (integer) - Optional - Quantity of the product.

### Request Example
```json
{
  "counterId": XXXXXX,
  "ecommerceData": {
    "purchase": {
      "actionField": {
        "id": "TRX987"
      },
      "products": [
        {
          "id": "25341",
          "name": "Толстовка Яндекс мужская",
          "price": 1345.26,
          "brand": "Яндекс / Яndex",
          "category": "Одежда/Мужская одежда/Толстовки и свитшоты",
          "variant": "Оранжевый цвет"
        },
        {
          "id": "25314",
          "name": "Толстовка Яндекс женская",
          "price": 1543.62,
          "brand": "Яндекс / Яndex",
          "category": "Одежда/Женская одежда/Толстовки и свитшоты",
          "variant": "Белый цвет",
          "quantity": 3
        }
      ]
    }
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the e-commerce data transmission.

#### Response Example
```json
{
  "status": "ecommerce_data_sent"
}
```
```

--------------------------------

### Disable Yandex Metrica on SPA using `destruct()` (JavaScript)

Source: https://yandex.ru/support/metrica/ru/code/counter-spa-setup

This snippet demonstrates how to disable the Yandex Metrica counter on a Single-Page Application using the `.destruct()` method. It is applicable for counters initialized via the `Ya.Metrika2` constructor, both with and without additional settings. Ensure you are using the new version of the Metrica counter code.

```javascript
const counterId = 'YOUR_COUNTER_ID';

// Initialize counter without settings
const counter1 = new Ya.Metrika2(counterId);

// Deinitialize counter
counter1.destruct();

// Initialize counter with settings
const counter2 = new Ya.Metrika2({
  id: counterId,
  trackLinks: true
});

// Deinitialize counter
counter2.destruct();
```
Tokens:
Raw