List of available counters

Returns a list of existing counters available to the user.

Request

GET

https://api-metrika.yandex.net/management/v1/counters

Query parameters

Name

Description

callback

Type: string

Callback function that processes the API response.

Example: ``

counter_ids

Type: integer[]

List of IDs of counters you want to get.

Example: ``

favorite

Type: boolean

Filter by counters that were added to Favorites.

Default: false

field

Type: string

One or several additional parameters of a returned object. The names of the additional parameters are specified in any order, separated by commas, without spaces. Example: field=goals,mirrors,grants,filters,operations,counter_flags,measurement_tokens.

Example: ``

label_id

Type: integer

Filter by label.

offset

Type: integer

Serial number of the counter to start the list of counters. The first counter has the number 1.

Default: 1

per_page

Type: integer

Number of counters that you want to receive.

Default: 1000

permission

Type: string

Filter by level of access to the counter. Parameter can include multiple values separated by commas:

  • own: Counter that belongs to the user.
  • view: Counter with guest access level (view only).
  • edit: Guest counter with full access.

Example: ``

reverse

Type: boolean

Display counters in ascending or descending order.

Default: true

robots

Type: boolean

Whether to include robot sessions

Default: true

search_string

Type: string

Filter by string. You can specify:

  • Counter ID.
  • Counter name.
  • Address of the site where the counter is installed.
  • Additional address.

The response will include counters that have the specified substring in their name, site, or mirrors. To filter by ID, specify the full ID.

Example: ``

sort

Type: string

Sorting:

  • None: No sorting.
  • Default: Default sorting.
  • Visits: Number of sessions.
  • Hits: Number of hits.
  • Uniques: Number of users.
  • Name: Counter name.

Default: Default

Example: ``

status

Type: string

Filter by counter status. Enabled by default. Counter status. Possible values:

  • Active: Counter active.
  • Deleted: Counter deleted.

Default: Active

Example: ``

type

Type: string

Filter by counter type. Counter type. Possible values:

  • simple: Counter created by the user in Yandex Metrica.
  • partner: Counter imported from YAN.

Example: ``

Responses

200 OK

OK

Body

application/json
{
  "rows": 0,
  "counters": [
    {
      "id": 0,
      "status": "example",
      "owner_login": "example",
      "activity_status": "example",
      "name": "example",
      "type": "example",
      "favorite": true,
      "hide_address": true,
      "pro": true,
      "pro_features": [
        "example"
      ],
      "permission": "example",
      "goals": [
        null
      ],
      "filters": [
        {
          "id": 0,
          "attr": "example",
          "type": "example",
          "value": "example",
          "action": "example",
          "status": "example",
          "start_ip": "example",
          "end_ip": "example",
          "with_subdomains": true
        }
      ],
      "operations": [
        {
          "id": 0,
          "action": "example",
          "attr": "example",
          "value": "example",
          "status": "example"
        }
      ],
      "grants": [
        {}
      ],
      "labels": [
        {
          "id": 0,
          "name": "example"
        }
      ],
      "webvisor": {
        "urls": "example",
        "arch_enabled": true,
        "arch_type": "example",
        "load_player_type": "example",
        "wv_version": 0,
        "allow_wv2": true,
        "notify_wv2": true,
        "wv_forms": true
      },
      "code_options": {
        "async": true,
        "informer": {
          "enabled": true,
          "type": "example",
          "size": 1,
          "indicator": "example",
          "color_start": "FFFFFFFF.",
          "color_end": "EFEFEFFF",
          "color_text": 0,
          "color_arrow": 0
        },
        "visor": true,
        "track_hash": true,
        "xml_site": true,
        "clickmap": true,
        "in_one_line": true,
        "ecommerce": true,
        "alternative_cdn": true,
        "ecommerce_object": "example",
        "ytm": true,
        "ssr": true
      },
      "create_time": "2025-01-01T00:00:00Z",
      "time_zone_name": "example",
      "time_zone_offset": 0,
      "partner_id": 0,
      "title": "example",
      "grants_cnt": 0,
      "source": "example",
      "site2": {
        "site": "example",
        "domain": "example",
        "status": "example"
      },
      "gdpr_agreement_accepted": true,
      "delete_guest_allowed": true,
      "mirrors2": [
        null
      ],
      "cms": {
        "code": "example",
        "custom": "example"
      },
      "crm": {
        "code": "example",
        "custom": "example"
      },
      "communication_channel": [
        {
          "code": "example",
          "custom": "example"
        }
      ],
      "industry": [
        {
          "code": "example",
          "custom": "example"
        }
      ],
      "site_activity": {
        "code": "example",
        "custom": "example"
      },
      "user_activity": [
        {
          "code": "example",
          "custom": "example"
        }
      ]
    }
  ]
}

Name

Description

counters

Type: CounterBrief[]

List of counters.

Example
[
  {
    "id": 0,
    "status": "example",
    "owner_login": "example",
    "activity_status": "example",
    "name": "example",
    "type": "example",
    "favorite": true,
    "hide_address": true,
    "pro": true,
    "pro_features": [
      "example"
    ],
    "permission": "example",
    "goals": [
      null
    ],
    "filters": [
      {
        "id": 0,
        "attr": "example",
        "type": "example",
        "value": "example",
        "action": "example",
        "status": "example",
        "start_ip": "example",
        "end_ip": "example",
        "with_subdomains": true
      }
    ],
    "operations": [
      {
        "id": 0,
        "action": "example",
        "attr": "example",
        "value": "example",
        "status": "example"
      }
    ],
    "grants": [
      {
        "user_login": "example",
        "user_uid": 0,
        "perm": "example",
        "created_at": "2025-01-01T00:00:00Z",
        "comment": "example",
        "email": "example",
        "partner_data_access": true
      }
    ],
    "labels": [
      {
        "id": 0,
        "name": "example"
      }
    ],
    "webvisor": {
      "urls": "example",
      "arch_enabled": true,
      "arch_type": "example",
      "load_player_type": "example",
      "wv_version": 0,
      "allow_wv2": true,
      "notify_wv2": true,
      "wv_forms": true
    },
    "code_options": {
      "async": true,
      "informer": {
        "enabled": true,
        "type": "example",
        "size": 1,
        "indicator": "example",
        "color_start": "FFFFFFFF.",
        "color_end": "EFEFEFFF",
        "color_text": 0,
        "color_arrow": 0
      },
      "visor": true,
      "track_hash": true,
      "xml_site": true,
      "clickmap": true,
      "in_one_line": true,
      "ecommerce": true,
      "alternative_cdn": true,
      "ecommerce_object": "example",
      "ytm": true,
      "ssr": true
    },
    "create_time": "2025-01-01T00:00:00Z",
    "time_zone_name": "example",
    "time_zone_offset": 0,
    "partner_id": 0,
    "title": "example",
    "grants_cnt": 0,
    "source": "example",
    "site2": {
      "site": "example",
      "domain": "example",
      "status": "example"
    },
    "gdpr_agreement_accepted": true,
    "delete_guest_allowed": true,
    "mirrors2": [
      null
    ],
    "cms": {
      "code": "example",
      "custom": "example"
    },
    "crm": {
      "code": "example",
      "custom": "example"
    },
    "communication_channel": [
      {
        "code": "example",
        "custom": "example"
      }
    ],
    "industry": [
      {
        "code": "example",
        "custom": "example"
      }
    ],
    "site_activity": {
      "code": "example",
      "custom": "example"
    },
    "user_activity": [
      {
        "code": "example",
        "custom": "example"
      }
    ]
  }
]

rows

Type: integer

Number of counters that match the request, excluding the offset and per_page parameters.

GoalE

Name

Description

name

Type: string

Goal name.

Min length: 0

Max length: 255

Example: example

type

Type: string

Goal type:

  • action: JavaScript event.
  • chat: Click on a chat.
  • email: Click on an email address.
  • file: File download.
  • messenger: Click-through to a messenger.
  • number: Number of views.
  • payment_system: Payment system.
  • phone: Click on a phone number.
  • search: Site search.
  • social: Click-through to social media.
  • step: Multi-step goal.
  • url: Pageviews.
  • visit_duration: Session duration.

Example: example

default_price

Type: number

Default goal cost.

goal_source

Type: string

Indicates how the goal was created:

  • user: The goal was created by a Yandex Metrica user.
  • auto: The goal was created automatically. Such goals include automatic goals and the Call goal (created when passing call data).

Example: example

id

Type: integer

ID of the goal. Specify this parameter when changing and deleting a counter goal.

is_favorite

Type: boolean

Whether the goal is favorite:

  • 0: False (default).
  • 1: True.

status

Type: string

Example: example
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}

GoalCondition

List of structures with the goal conditions.

Name

Description

type

Type: string

Condition type:

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of conditions for the “JavaScript event” goals.
  • messenger: Special type of conditions for “form“ goals, path in the DOM tree.
  • all_files: Attribute for “Open messenger“ goals.
  • file: Downloading a specific file for “File downloads” goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special condition type for social goals (all social networks).
  • social: Special condition type for social goals (a specific social network).
  • regexp_action: JS event matches a regular expression (used exclusively in a step of a multi-step goal).
  • contain_action: JS event contains (used only in a step of a multi-step goal).

Example: example

url

Type: string

The value depends on the goal type:

  • Page view. The URL of the page or a section of the page for the condition.
  • Click on email or Click on phone number. Email or phone number specified in the links on the site. Learn more about tracking clicks on email addresses or phone numbers.
  • Open a messaging app. Name of the messaging app retrieved using the GET management/v1/messengers method, or the all_messengers value.
  • Site search. The GET parameter that is used for site search. Yandex Metrica automatically recognizes the q, text, query, and search parameters. If the site uses a different parameter, specify it in the request.
  • File download. File name. For example, example.pdf. You can leave this blank if you want to track all file downloads on the site.
  • Click-through to a social network. The name of the social network, obtained using the GET management/v1/social_networks method, or the all_social value.

Example: example
Example
{
  "type": "example",
  "url": "example"
}

ActionGoal

JavaScript event.

All of 2 types

  • Type: GoalE

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
  {
    "type": "example",
    "url": "example"
  }
]

    flag

    Type: string

    Goal type for Yandex Market clients:

    • basket: Shopping cart, shopping cart page.
    • order: Order, order confirmation page.

    Example: example
    Example
    {
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

ChatGoalCondition

List of structures with the goal conditions.

Name

Description

field

Type: string

What the goal applies to.

Example: example
Example
{
  "field": "example"
}

ChatGoalConditionAnswered

All of 2 types

  • Type: ChatGoalCondition

    List of structures with the goal conditions.

    Example
    {
  "field": "example"
}
  • Type: object

    answered

    Type: boolean

    Status of a chat response.
    Example
    {
  "answered": true
}
Example
{
  "field": "example",
  "answered": true
}

ChatGoalConditionPlatform

All of 2 types

  • Type: ChatGoalCondition

    List of structures with the goal conditions.

    Example
    {
  "field": "example"
}
  • Type: object

    platform

    Type: string

    Chat platform. Possible values:

    • telegram
    • viber
    • whatsApp

    Example: telegram
    Example
    {
  "platform": "telegram"
}
Example
{
  "field": "example",
  "platform": "telegram"
}

ChatGoalConditionTag

All of 2 types

  • Type: ChatGoalCondition

    List of structures with the goal conditions.

    Example
    {
  "field": "example"
}
  • Type: object

    operator

    Type: string

    Condition type. Possible values:

    • contain: Contains.
    • exact: Matches exactly.
    • start: Starts with.
    • regexp: Matches a regular expression.

    Example: example

    value

    Type: string

    Min length: 1

    Max length: 1024

    Example: example
    Example
    {
  "operator": "example",
  "value": "example"
}
Example
{
  "field": "example",
  "operator": "example",
  "value": "example"
}

ChatGoal

Click or tap on a chat.

All of 2 types

  • Type: GoalE

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
  • Type: object

    conditions
    Type: array
    One of 3 types
    Example
    [
  {
    "field": "example",
    "answered": true
  }
]
    Example
    {
  "conditions": [
    {
      "field": "example",
      "answered": true
    }
  ]
}
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    null
  ]
}

ConditionalGoal

List of steps in a multi-step goal.

Name

Description

name

Type: string

Goal name.

Min length: 0

Max length: 255

Example: example

type

Type: string

Goal type:

  • action: JavaScript event.
  • chat: Click on a chat.
  • email: Click on an email address.
  • file: File download.
  • messenger: Click-through to a messenger.
  • number: Number of views.
  • payment_system: Payment system.
  • phone: Click on a phone number.
  • search: Site search.
  • social: Click-through to social media.
  • step: Multi-step goal.
  • url: Pageviews.
  • visit_duration: Session duration.

Example: example

conditions

Type: GoalCondition[]

Example
[
  {
    "type": "example",
    "url": "example"
  }
]

default_price

Type: number

Default goal cost.

flag

Type: string

Goal type for Yandex Market clients:

  • basket: Shopping cart, shopping cart page.
  • order: Order, order confirmation page.

Example: example

goal_source

Type: string

Indicates how the goal was created:

  • user: The goal was created by a Yandex Metrica user.
  • auto: The goal was created automatically. Such goals include automatic goals and the Call goal (created when passing call data).

Example: example

id

Type: integer

ID of the goal. Specify this parameter when changing and deleting a counter goal.

is_favorite

Type: boolean

Whether the goal is favorite:

  • 0: False (default).
  • 1: True.

status

Type: string

Example: example
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

CompositeGoal

Multi-step goal. Used for grouping and setting the order of usual goals. The "Page view" and "JavaScript event" goals can be steps of a multi-step goal. A step is considered completed if all the previous steps were completed and all the current step's conditions were met.

All of 2 types

  • Type: GoalE

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
  • Type: object

    steps

    Type: ConditionalGoal[]

    Min items: 0

    Max items: 5

    Example
    [
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_retargeting": true,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {
        "type": "example",
        "url": "example"
      }
    ],
    "prev_goal_id": 0,
    "flag": "example"
  }
]
    Example
    {
  "steps": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {
          "type": "example",
          "url": "example"
        }
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
  ]
}
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "steps": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {}
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
  ]
}

DepthGoal

Page depth. The goal is considered achieved if the user viewed the specified number of site pages.

All of 2 types

  • Type: GoalE

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
  • Type: object

    depth

    Type: integer

    Number of pages viewed by the user.

    Min value: 2
    Example
    {
  "depth": 2
}
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "depth": 2
}

EmailGoal

Clicks or taps on an email address.

All of 2 types

  • Type: GoalE

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
  {
    "type": "example",
    "url": "example"
  }
]

    flag

    Type: string

    Goal type for Yandex Market clients:

    • basket: Shopping cart, shopping cart page.
    • order: Order, order confirmation page.

    Example: example
    Example
    {
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

FileGoal

File download. The goal is considered achieved if the user downloaded any file or a specific file.

All of 2 types

  • Type: GoalE

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
  {
    "type": "example",
    "url": "example"
  }
]

    flag

    Type: string

    Goal type for Yandex Market clients:

    • basket: Shopping cart, shopping cart page.
    • order: Order, order confirmation page.

    Example: example
    Example
    {
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

MessengerGoal

Click-through to a messaging app. The goal will be achieved once the user clicks the link to the messaging app.

All of 2 types

  • Type: GoalE

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
  {
    "type": "example",
    "url": "example"
  }
]

    flag

    Type: string

    Goal type for Yandex Market clients:

    • basket: Shopping cart, shopping cart page.
    • order: Order, order confirmation page.

    Example: example
    Example
    {
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

PaymentSystemGoal

Payment systems. The goal is considered achieved if the user makes a payment via a payment system.

All of 1 type

  • Type: GoalE

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}

PhoneGoal

Clicks or taps on the phone number.

All of 2 types

  • Type: GoalE

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
  {
    "type": "example",
    "url": "example"
  }
]

    flag

    Type: string

    Goal type for Yandex Market clients:

    • basket: Shopping cart, shopping cart page.
    • order: Order, order confirmation page.

    Example: example

    hide_phone_number

    Type: boolean

    Hide the phone number on desktop devices.
    Example
    {
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example",
  "hide_phone_number": true
}
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example",
  "hide_phone_number": true
}

SiteSearchGoal

Site search. The goal will be achieved when performing a site search if there is at least one match in the URL specified in the GET parameters.

All of 2 types

  • Type: GoalE

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
  {
    "type": "example",
    "url": "example"
  }
]

    flag

    Type: string

    Goal type for Yandex Market clients:

    • basket: Shopping cart, shopping cart page.
    • order: Order, order confirmation page.

    Example: example
    Example
    {
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

SocialNetworkGoal

Click-through to a social network. The goal will be achieved once the user clicks the link to the social network.

All of 2 types

  • Type: GoalE

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
  {
    "type": "example",
    "url": "example"
  }
]

    flag

    Type: string

    Goal type for Yandex Market clients:

    • basket: Shopping cart, shopping cart page.
    • order: Order, order confirmation page.

    Example: example
    Example
    {
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

UrlGoal

Pageviews. Achieved when at least one condition is met.

All of 2 types

  • Type: GoalE

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
  • Type: object

    conditions

    Type: GoalCondition[]

    Example
    [
  {
    "type": "example",
    "url": "example"
  }
]

    flag

    Type: string

    Goal type for Yandex Market clients:

    • basket: Shopping cart, shopping cart page.
    • order: Order, order confirmation page.

    Example: example
    Example
    {
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "flag": "example"
}

VisitDurationGoal

Session duration. The goal will be achieved if the session duration exceeds the specified one.

All of 2 types

  • Type: GoalE

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}
  • Type: object

    duration

    Type: integer

    Session duration in seconds.

    Min value: 1
    Example
    {
  "duration": 1
}
Example
{
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "duration": 1
}

FilterE

List of structures with information on counter filters.

Name

Description

action

Type: string

Filter type:

  • exclude: Exclude traffic.
  • include: Leave only traffic.

Example: example

attr

Type: string

Data type the filter is applied to:

  • title: Page title.
  • client_ip: IP address.
  • url: Page URL.
  • referer: Referrer.
  • uniq_id: Special attribute for the Don't count my sessions filter.

Example: example

status

Type: string

Filter status:

  • active: Filter is used.
  • disabled: Filter disabled (but not deleted).

Example: example

type

Type: string

Filter type or action for filter:

  • equal: Equal to.
  • start: Starts with.
  • contain: Contains.
  • interval: In the interval, only used with the "IP address" data type (attr = client_ip).
  • me: My visits, only used with the attr = uniq_id data type.
  • only_mirrors: Only the site and its mirrors, used only for the Page URL data type (attr = url) and the Leave only traffic filter type (action = include), and provided that mirrors are specified for the counter.
  • regexp: Regular expression.

Example: example

end_ip

Type: string

The last IP address in the range.

Example: example

id

Type: integer

Filter ID. Specify this parameter when changing a counter filter.

start_ip

Type: string

The first IP address in the range.

Example: example

value

Type: string

Filter value.

Example: example

with_subdomains

Type: boolean

Filter by subdomain.
Example
{
  "id": 0,
  "attr": "example",
  "type": "example",
  "value": "example",
  "action": "example",
  "status": "example",
  "start_ip": "example",
  "end_ip": "example",
  "with_subdomains": true
}

OperationE

List of structures with information on counter actions.

Name

Description

action

Type: string

Action type:

  • cut_fragment: Remove an anchor from the URL.
  • cut_parameter: Remove a specific parameter from the URL.
  • cut_all_parameters: Remove all parameters from the URL.
  • merge_https_and_http: Replace https:// with http://.
  • to_lower: Convert to lower case.
  • replace_domain: Replace a domain.

Example: example

attr

Type: string

Field for filtering:

  • referer: Referrer.
  • url: Page URL.

Example: example

status

Type: string

Action status:

  • active: Action is used.
  • disabled: Action is disabled (but not deleted).

Example: example

id

Type: integer

Action ID (needs to be specified while changing a counter action).

value

Type: string

Value for replacement.

Example: example
Example
{
  "id": 0,
  "action": "example",
  "attr": "example",
  "value": "example",
  "status": "example"
}

CounterGrantE

List of structures with information on access rights to the counter.

Name

Description

perm

Type: string

Access level:

  • public_stat: Public access to statistics.
  • view: Read only.
  • edit: Full access.
  • analyst: Analyst.
  • analyst_access_filter: Data analyst with filter-based access.

Example: example

comment

Type: string

Custom comment. The maximum number of characters is 255.

Min length: 0

Max length: 255

Example: example

created_at

Type: string<date-time>

Date when the permission was granted in YYYY-MM-DD'T'hh:mm:ssZ format.

Example: 2025-01-01T00:00:00Z

partner_data_access

Type: boolean

Access to the Monetization report group. The user can view reports and add dimensions and metrics from the Monetization group to other reports. Users with edit permissions already have access to the reports within the "Monetization" group. Possible values:

  • true: Access granted.
  • false: Access denied.

user_login

Type: string

Login of a user with counter management rights. This parameter contains an empty string if counter statistics are in public access (perm = public_stat).

Example: example
Example
{
  "user_login": "example",
  "perm": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "comment": "example",
  "partner_data_access": true
}

AccessFiltersShortE

List of access filters granted to the user.

Name

Description

id

Type: integer

Access filter ID.

name

Type: string

Access filter name.

Example: example
Example
{
  "id": 0,
  "name": "example"
}

AccessFiltersGrantE

All of 2 types

  • Type: CounterGrantE

    List of structures with information on access rights to the counter.

    Example
    {
  "user_login": "example",
  "user_uid": 0,
  "perm": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "comment": "example",
  "email": "example",
  "partner_data_access": true
}
  • Type: object

    access_filters

    Type: AccessFiltersShortE[]

    Min items: 1

    Max items: 1

    Example
    [
  {
    "id": 0,
    "name": "example"
  }
]
    Example
    {
  "access_filters": [
    {
      "id": 0,
      "name": "example"
    }
  ]
}
Example
{
  "user_login": "example",
  "user_uid": 0,
  "perm": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "comment": "example",
  "email": "example",
  "partner_data_access": true,
  "access_filters": [
    {
      "id": 0,
      "name": "example"
    }
  ]
}

Label

Label.

Name

Description

id

Type: integer

Label ID.

name

Type: string

Label name.

Min length: 0

Max length: 255

Example: example
Example
{
  "id": 0,
  "name": "example"
}

WebvisorOptions

Structure with information on Session Replay settings.

Name

Description

arch_enabled

Type: boolean

Saving site pages:

  • 0: Disabled (default).
  • 1: Enabled.

arch_type

Type: string

Recording page content:

  • none: Disabled.
  • load: Download from site.
  • html: From browser.

Example: example

load_player_type

Type: string

Loading pages in the player:

  • proxy: As an anonymous user.
  • on_your_behalf: As you.

Example: example

urls

Type: string

List of pages for saving.

Min length: 0

Max length: 2000

Example: example

wv_forms

Type: boolean

Records the content of fields and forms:

  • 0: Don't record the content of fields and forms, except those marked with the -metrika-recordkeys CSS class.
  • 1: Record the content of fields and forms, except those marked with the -metrika-nokeys CSS class (default).

wv_version

Type: integer

Session Replay version.
Example
{
  "urls": "example",
  "arch_enabled": true,
  "arch_type": "example",
  "load_player_type": "example",
  "wv_version": 0,
  "wv_forms": true
}

InformerOptionsE

Informer settings.

Name

Description

color_arrow

Type: integer

Color of the arrow in the informer:

  • 0: Black.
  • 1: Purple (default).

Min value: 0

Max value: 1

color_end

Type: string

End (bottom) color of the informer in RRGGBBAA format. This parameter is used to create a background gradient. You can set color saturation and transparency the same way as with the "color_start" parameter.

Default: EFEFEFFF

Pattern: [0-9A-F]{8}

color_start

Type: string

The color at the top of the informer, specified in RRGGBBAA format. RR, GG, BB are saturated red, green, and blue colors. Saturation for each color is specified using a value from 00 to FF. AA: transparency, from 00 (transparent) to FF (opaque).

Default: FFFFFFFF.

Pattern: [0-9A-F]{8}

color_text

Type: integer

Color of the text in the informer:

  • 0: Black (default).
  • 1: White.

Min value: 0

Max value: 1

enabled

Type: boolean

Permission to display the informer:

  • 0: Informer is not displayed (default).
  • 1: Informer is displayed.

indicator

Type: string

The parameter that will be shown on the informer:

  • pageviews: Pageviews (default).
  • visits: Sessions.
  • uniques: Users.

Example: example

size

Type: integer

Informer size:

  • 1: 80×15
  • 2: 80х31
  • 3: 88×31 (default). The value in the indicator field doesn't change the appearance of this informer type.

Min value: 1

Max value: 3

type

Type: string

Informer type:

  • simple: Simple.
  • ext: Extended (default).

Example: example
Example
{
  "enabled": true,
  "type": "example",
  "size": 1,
  "indicator": "example",
  "color_start": "FFFFFFFF.",
  "color_end": "EFEFEFFF",
  "color_text": 0,
  "color_arrow": 0
}

CodeOptionsE

Counter code settings.

Name

Description

alternative_cdn

Type: boolean

This option ensures accurate tracking of sessions from regions where access to Yandex services is restricted. It might take longer to load the counter code when using this option:

  • 0: Disabled (default).
  • 1: Enabled.

async

Type: boolean

Asynchronous counter code:

  • 0: Disabled.
  • 1: Enabled (default).

clickmap

Type: boolean

Gathering statistics for the Click Map report:

  • 0: Disabled (default).
  • 1: Enabled.

ecommerce

Type: boolean

Collecting E-commerce data:

  • 0: Disabled (default).
  • 1: Enabled.

in_one_line

Type: boolean

Print a counter code as a single string:

  • 0: Disabled (default).
  • 1: Enabled.

informer

Type: InformerOptionsE

Informer settings.

Example
{
  "enabled": true,
  "type": "example",
  "size": 1,
  "indicator": "example",
  "color_start": "FFFFFFFF.",
  "color_end": "EFEFEFFF",
  "color_text": 0,
  "color_arrow": 0
}

track_hash

Type: boolean

Hash tracking in the browser address bar. The option applies to AJAX sites:

  • 0: Disabled (default).
  • 1: Enabled.

visor

Type: boolean

Record and analysis of site user behavior:

  • 0: Disabled (default).
  • 1: Enabled.

xml_site

Type: boolean

For XML sites. The "noscript" element can't be used in XML documents:

  • 0: Disabled (default).
  • 1: Enabled.

ytm

Type: boolean

Whether the counter management system is used. Possible values:

  • 0: Not used.
  • 1: Used.
Example
{
  "async": true,
  "informer": {
    "enabled": true,
    "type": "example",
    "size": 1,
    "indicator": "example",
    "color_start": "FFFFFFFF.",
    "color_end": "EFEFEFFF",
    "color_text": 0,
    "color_arrow": 0
  },
  "visor": true,
  "track_hash": true,
  "xml_site": true,
  "clickmap": true,
  "in_one_line": true,
  "ecommerce": true,
  "alternative_cdn": true,
  "ytm": true
}

CounterMirrorE

List of site mirrors (domains).

Name

Description

site

Type: string

Full site domain.

Min length: 0

Max length: 255

Example: example
Example
{
  "site": "example"
}

CounterCms

Tag CMS system. Possible values for the "code" field:

  • bitrix24: Bitrix24.
  • flexbe: Flexbe.
  • joomla: Joomla.
  • drupal: Drupal.
  • opencart: OpenCart.
  • tilda: Tilda.
  • webasyst: Webasyst.
  • wix: Wix.
  • wordpress: Wordpress.
  • insales: Insales.
  • nethouse: Nethouse. You can also pass a custom value using the "custom" field (up to 128 characters).

Name

Description

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 128

Example: example
Example
{
  "code": "example",
  "custom": "example"
}

CounterCrm

Tag CRM system. Possible values for the "code" field:

  • amocrm: AmoCRM.
  • bitrix24: Bitrix24.
  • megaplan: Megaplan.
  • crm_1c: 1С:CRM.
  • moysklad: Moy sklad.
  • yclients: Yclients.
  • retailcrm: RetailCRM. You can also pass a custom value using the "custom" field (up to 128 characters).

Name

Description

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 128

Example: example
Example
{
  "code": "example",
  "custom": "example"
}

SiteActivityProfile

Tag activity profile. Possible values for the "code" field:

  • retail: Online store.
  • promo_site: Promo website.
  • online_service: Cloud app.
  • text_site: Informational website. You can also pass a custom value using the "custom" field (up to 1000 characters).

Name

Description

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 1000

Example: example
Example
{
  "code": "example",
  "custom": "example"
}

LocationOnPage

Name

Description

path

Type: string

Location on the page

Min length: 0

Max length: 4096

Example: example

type_of_path

Type: string

Type of the specified location

Example: example
Example
{
  "type_of_path": "example",
  "path": "example"
}

CounterBrief

Name

Description

activity_status

Type: string

Counter traffic. Possible values:

  • low: Low traffic.
  • high: High traffic.

Example: example

cms

Type: CounterCms

Tag CMS system. Possible values for the "code" field:

  • bitrix24: Bitrix24.
  • flexbe: Flexbe.
  • joomla: Joomla.
  • drupal: Drupal.
  • opencart: OpenCart.
  • tilda: Tilda.
  • webasyst: Webasyst.
  • wix: Wix.
  • wordpress: Wordpress.
  • insales: Insales.
  • nethouse: Nethouse. You can also pass a custom value using the "custom" field (up to 128 characters).
Example
{
  "code": "example",
  "custom": "example"
}

code_options

Type: CodeOptionsE

Counter code settings.

Example
{
  "async": true,
  "informer": {
    "enabled": true,
    "type": "example",
    "size": 1,
    "indicator": "example",
    "color_start": "FFFFFFFF.",
    "color_end": "EFEFEFFF",
    "color_text": 0,
    "color_arrow": 0
  },
  "visor": true,
  "track_hash": true,
  "xml_site": true,
  "clickmap": true,
  "in_one_line": true,
  "ecommerce": true,
  "alternative_cdn": true,
  "ecommerce_object": "example",
  "ytm": true,
  "ssr": true
}

create_time

Type: string<date-time>

Date and time when the counter was created.

Example: 2025-01-01T00:00:00Z

crm

Type: CounterCrm

Tag CRM system. Possible values for the "code" field:

  • amocrm: AmoCRM.
  • bitrix24: Bitrix24.
  • megaplan: Megaplan.
  • crm_1c: 1С:CRM.
  • moysklad: Moy sklad.
  • yclients: Yclients.
  • retailcrm: RetailCRM. You can also pass a custom value using the "custom" field (up to 128 characters).
Example
{
  "code": "example",
  "custom": "example"
}

favorite

Type: boolean

Whether the counter is added to favorites:

  • 0: Not added (default).
  • 1: Added.

filters

Type: FilterE[]

Example
[
  {
    "id": 0,
    "attr": "example",
    "type": "example",
    "value": "example",
    "action": "example",
    "status": "example",
    "start_ip": "example",
    "end_ip": "example",
    "with_subdomains": true
  }
]

gdpr_agreement_accepted

Type: boolean

Acceptance of the Yandex Metrica Data Processing Agreement.

  • 0: Agreement not accepted (default).
  • 1: Agreement accepted.

goals
Type: array
One of 13 types

  • Type: ActionGoal

    JavaScript event.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "prev_goal_id": 0,
  "flag": "example"
}

  • Type: ChatGoal

    Click or tap on a chat.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    null
  ]
}

  • Type: CompositeGoal

    Multi-step goal. Used for grouping and setting the order of usual goals. The "Page view" and "JavaScript event" goals can be steps of a multi-step goal. A step is considered completed if all the previous steps were completed and all the current step's conditions were met.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "steps": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        {}
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
  ]
}

  • Type: DepthGoal

    Page depth. The goal is considered achieved if the user viewed the specified number of site pages.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "depth": 2
}

  • Type: EmailGoal

    Clicks or taps on an email address.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "prev_goal_id": 0,
  "flag": "example"
}

  • Type: FileGoal

    File download. The goal is considered achieved if the user downloaded any file or a specific file.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "prev_goal_id": 0,
  "flag": "example"
}

  • Type: MessengerGoal

    Click-through to a messaging app. The goal will be achieved once the user clicks the link to the messaging app.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "prev_goal_id": 0,
  "flag": "example"
}

  • Type: PaymentSystemGoal

    Payment systems. The goal is considered achieved if the user makes a payment via a payment system.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example"
}

  • Type: PhoneGoal

    Clicks or taps on the phone number.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "prev_goal_id": 0,
  "flag": "example",
  "hide_phone_number": true
}

  • Type: SiteSearchGoal

    Site search. The goal will be achieved when performing a site search if there is at least one match in the URL specified in the GET parameters.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "prev_goal_id": 0,
  "flag": "example"
}

  • Type: SocialNetworkGoal

    Click-through to a social network. The goal will be achieved once the user clicks the link to the social network.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "prev_goal_id": 0,
  "flag": "example"
}

  • Type: UrlGoal

    Pageviews. Achieved when at least one condition is met.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "conditions": [
    {
      "type": "example",
      "url": "example"
    }
  ],
  "prev_goal_id": 0,
  "flag": "example",
  "price_locations": [
    {
      "type_of_path": "example",
      "path": "example"
    }
  ]
}

  • Type: VisitDurationGoal

    Session duration. The goal will be achieved if the session duration exceeds the specified one.

    Example
    {
  "id": 0,
  "name": "example",
  "type": "example",
  "default_price": 0.5,
  "is_retargeting": true,
  "goal_source": "example",
  "is_favorite": true,
  "status": "example",
  "duration": 1
}

List of structures with information on counter goals.

Example
[
  {
    "id": 0,
    "name": "example",
    "type": "example",
    "default_price": 0.5,
    "is_retargeting": true,
    "goal_source": "example",
    "is_favorite": true,
    "status": "example",
    "conditions": [
      {}
    ],
    "prev_goal_id": 0,
    "flag": "example"
  }
]

grants
Type: array
One of 2 types

  • Type: CounterGrantE

    List of structures with information on access rights to the counter.

    Example
    {
  "user_login": "example",
  "user_uid": 0,
  "perm": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "comment": "example",
  "email": "example",
  "partner_data_access": true
}

  • Type: AccessFiltersGrantE

    Example
    {
  "user_login": "example",
  "user_uid": 0,
  "perm": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "comment": "example",
  "email": "example",
  "partner_data_access": true,
  "access_filters": [
    {
      "id": 0,
      "name": "example"
    }
  ]
}
Example
[
  {
    "user_login": "example",
    "user_uid": 0,
    "perm": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "comment": "example",
    "email": "example",
    "partner_data_access": true
  }
]

id

Type: integer

Counter ID.

labels

Type: Label[]

List of structures with information on labels.

Example
[
  {
    "id": 0,
    "name": "example"
  }
]

mirrors2

Type: CounterMirrorE[]

Example
[
  {
    "site": "example",
    "domain": "example",
    "status": "example"
  }
]

name

Type: string

Counter name.

Min length: 0

Max length: 255

Example: example

operations

Type: OperationE[]

Example
[
  {
    "id": 0,
    "action": "example",
    "attr": "example",
    "value": "example",
    "status": "example"
  }
]

owner_login

Type: string

Login of the counter owner.

Example: example

permission

Type: string

Level of access to the counter:

  • own: Counter belongs to the user.
  • view: Counter with guest access level (view only).
  • edit: Guest counter with full access.
  • analyst: Guest counter with the analytics access level.
  • view_access_filter: Guest counter with access filter view only access.
  • analyst_access_filter: Guest counter with access filter data analytics access.

Example: example

site_activity

Type: SiteActivityProfile

Tag activity profile. Possible values for the "code" field:

  • retail: Online store.
  • promo_site: Promo website.
  • online_service: Cloud app.
  • text_site: Informational website. You can also pass a custom value using the "custom" field (up to 1000 characters).
Example
{
  "code": "example",
  "custom": "example"
}

site2

Type: CounterMirrorE

List of site mirrors (domains).

Example
{
  "site": "example",
  "domain": "example",
  "status": "example"
}

source

Type: string

Counter type. Possible values:

  • turbodirect: Turbo Direct.
  • marketplace_direct: Yandex Direct marketplaces.
  • sprav: Yandex Business.
  • partner: Yandex Advertising Network.
  • system: System.
  • market: Yandex Market.
  • eda: Yandex Eats.
  • dzen: Zen.
  • geoadv: Advertising account.
  • games: Yandex Games.

Example: example

status

Type: string

Counter status. Possible values:

  • Active: Counter active.
  • Deleted: Counter deleted.

Example: example

time_zone_name

Type: string

Time zone for calculating statistics.

Example: example

time_zone_offset

Type: integer

Current time zone offset from GMT (minutes).

type

Type: string

Counter type. Possible values:

  • simple: Counter created by the user in Yandex Metrica.
  • partner: Counter imported from YAN.

Example: example

webvisor

Type: WebvisorOptions

Structure with information on Session Replay settings.

Example
{
  "urls": "example",
  "arch_enabled": true,
  "arch_type": "example",
  "load_player_type": "example",
  "wv_version": 0,
  "allow_wv2": true,
  "notify_wv2": true,
  "wv_forms": true
}
Example
{
  "id": 0,
  "status": "example",
  "owner_login": "example",
  "activity_status": "example",
  "name": "example",
  "type": "example",
  "favorite": true,
  "permission": "example",
  "goals": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
  ],
  "filters": [
    {
      "id": 0,
      "attr": "example",
      "type": "example",
      "value": "example",
      "action": "example",
      "status": "example",
      "start_ip": "example",
      "end_ip": "example",
      "with_subdomains": true
    }
  ],
  "operations": [
    {
      "id": 0,
      "action": "example",
      "attr": "example",
      "value": "example",
      "status": "example"
    }
  ],
  "grants": [
    {
      "user_login": "example",
      "user_uid": 0,
      "perm": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "comment": "example",
      "email": "example",
      "partner_data_access": true
    }
  ],
  "labels": [
    {
      "id": 0,
      "name": "example"
    }
  ],
  "webvisor": {
    "urls": "example",
    "arch_enabled": true,
    "arch_type": "example",
    "load_player_type": "example",
    "wv_version": 0,
    "allow_wv2": true,
    "notify_wv2": true,
    "wv_forms": true
  },
  "code_options": {
    "async": true,
    "informer": {
      "enabled": true,
      "type": "example",
      "size": 1,
      "indicator": "example",
      "color_start": "FFFFFFFF.",
      "color_end": "EFEFEFFF",
      "color_text": 0,
      "color_arrow": 0
    },
    "visor": true,
    "track_hash": true,
    "xml_site": true,
    "clickmap": true,
    "in_one_line": true,
    "ecommerce": true,
    "alternative_cdn": true,
    "ecommerce_object": "example",
    "ytm": true,
    "ssr": true
  },
  "create_time": "2025-01-01T00:00:00Z",
  "time_zone_name": "example",
  "time_zone_offset": 0,
  "source": "example",
  "site2": {
    "site": "example",
    "domain": "example",
    "status": "example"
  },
  "gdpr_agreement_accepted": true,
  "mirrors2": [
    null
  ],
  "cms": {
    "code": "example",
    "custom": "example"
  },
  "crm": {
    "code": "example",
    "custom": "example"
  },
  "site_activity": {
    "code": "example",
    "custom": "example"
  }
}

CommunicationChannel

Tag communication channels. Possible values for the "code" field:

  • messengers: Messengers.
  • call_track: Call tracking.
  • direct_call: Direct calls. You can also pass a custom value using the "custom" field (up to 1000 characters).

Name

Description

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 1000

Example: example
Example
{
  "code": "example",
  "custom": "example"
}

CounterIndustry

Tag industries. Possible values for the "code" field:

  • finance_and_insurance: Finance and insurance.
  • real_estate: Real estate.
  • construction: Construction and repair.
  • house_and_garden: Home and garden.
  • domestic_services: Personal services and food service.
  • electronics: Electronics.
  • healthcare: Medicine.
  • appliances: Household appliances.
  • gastronomy: Cooking and recipes.
  • auto_and_moto: Auto and moto.
  • engineering_and_technologies: Tech.
  • it_and_telecom: IT and telecom.
  • clothes: Clothing and footwear.
  • health_and_beauty: Health and beauty.
  • sport: Sports and active lifestyle.
  • jobs_and_career: Work and career.
  • education: Education.
  • family_and_kids: Family and children.
  • pets: Pets.
  • travel: Travel and tourism.
  • entertainment: Entertainment, leisure, 18+.
  • social_networks: Communication (social media, messengers).
  • gifts: Gifts.
  • business_and_consulting: Business and consulting.
  • advertisement: Advertising and marketing.
  • online_services: Online services.
  • industry: Industry and agriculture.
  • transportation: Transportation.
  • legal_services: Legal services and consulting.
  • government_and_society: State and society.
  • knowledge_sources: Reference resources.
  • news: News and media.
  • culture_and_art: Culture and art.
  • religion: Religion.
  • science: Science.
  • unexplored: Unknown. You can also pass a custom value using the "custom" field (up to 1000 characters).

Name

Description

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 1000

Example: example
Example
{
  "code": "example",
  "custom": "example"
}

UserActivityProfile

User activity profiles in the tag. Possible values:

  • business: Business management.
  • traffic: Marketing and advertising.
  • conversions: Sales and conversions.
  • product_management: Product management.
  • marketing: Content marketing.
  • design: User interface design.
  • development: Development and support.
  • analytics: Analytics. You can also pass a custom value using the "custom" field (up to 1000 characters).

Name

Description

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 1000

Example: example
Example
{
  "code": "example",
  "custom": "example"
}

No longer supported, please use an alternative and newer version.

Previous
Deleting a counter
Next
Creating a counter