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.
counter_ids	Type: integer<int32>[] List of IDs of counters you want to get.
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`.
label_id	Type: integer<int32> Filter by label.
offset	Type: integer<int32> Serial number of the counter to start the list of counters. The first counter has the number 1. Default: `1`
per_page	Type: integer<int32> 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.
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.
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`
status	Type: string Filter by counter status. Enabled by default. Counter status. Possible values: `Active`: Counter active. `Deleted`: Counter deleted. Default: `Active`
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.

Responses

200 OK

Body

application/json

{
    "rows": 0,
    "counters": [
        {
            "id": 0,
            "status": "string",
            "owner_login": "string",
            "activity_status": "string",
            "name": "string",
            "type": "string",
            "favorite": false,
            "permission": "string",
            "goals": [
                {
                    "id": 0,
                    "name": "string",
                    "type": "string",
                    "default_price": 0,
                    "goal_source": "string",
                    "is_favorite": false,
                    "status": "string",
                    "conditions": [
                        {
                            "type": "string",
                            "url": "string"
                        }
                    ],
                    "flag": "basket"
                },
                {
                    "id": 0,
                    "name": "string",
                    "type": "string",
                    "default_price": 0,
                    "goal_source": "string",
                    "is_favorite": false,
                    "status": "string",
                    "steps": [
                        {
                            "id": 0,
                            "name": "string",
                            "type": "string",
                            "default_price": 0,
                            "goal_source": "string",
                            "is_favorite": false,
                            "status": "string",
                            "conditions": [
                                {
                                    "type": "string",
                                    "url": "string"
                                }
                            ],
                            "flag": "string"
                        }
                    ]
                },
                {
                    "id": 0,
                    "name": "string",
                    "type": "string",
                    "default_price": 0,
                    "goal_source": "string",
                    "is_favorite": false,
                    "status": "string",
                    "depth": 0
                },
                {
                    "id": 0,
                    "name": "string",
                    "type": "string",
                    "default_price": 0,
                    "goal_source": "string",
                    "is_favorite": false,
                    "status": "string",
                    "conditions": [
                        {
                            "type": "string",
                            "url": "string"
                        }
                    ],
                    "flag": "basket"
                },
                {
                    "id": 0,
                    "name": "string",
                    "type": "string",
                    "default_price": 0,
                    "goal_source": "string",
                    "is_favorite": false,
                    "status": "string",
                    "conditions": [
                        {
                            "type": "string",
                            "url": "string"
                        }
                    ],
                    "flag": "basket"
                },
                {
                    "id": 0,
                    "name": "string",
                    "type": "string",
                    "default_price": 0,
                    "goal_source": "string",
                    "is_favorite": false,
                    "status": "string",
                    "conditions": [
                        {
                            "type": "string",
                            "url": "string"
                        }
                    ],
                    "flag": "basket"
                },
                {
                    "id": 0,
                    "name": "string",
                    "type": "string",
                    "default_price": 0,
                    "goal_source": "string",
                    "is_favorite": false,
                    "status": "string"
                },
                {
                    "id": 0,
                    "name": "string",
                    "type": "string",
                    "default_price": 0,
                    "goal_source": "string",
                    "is_favorite": false,
                    "status": "string",
                    "conditions": [
                        {
                            "type": "string",
                            "url": "string"
                        }
                    ],
                    "flag": "basket",
                    "hide_phone_number": false
                },
                {
                    "id": 0,
                    "name": "string",
                    "type": "string",
                    "default_price": 0,
                    "goal_source": "string",
                    "is_favorite": false,
                    "status": "string",
                    "conditions": [
                        {
                            "type": "string",
                            "url": "string"
                        }
                    ],
                    "flag": "basket"
                },
                {
                    "id": 0,
                    "name": "string",
                    "type": "string",
                    "default_price": 0,
                    "goal_source": "string",
                    "is_favorite": false,
                    "status": "string",
                    "conditions": [
                        {
                            "type": "string",
                            "url": "string"
                        }
                    ],
                    "flag": "basket"
                },
                {
                    "id": 0,
                    "name": "string",
                    "type": "string",
                    "default_price": 0,
                    "goal_source": "string",
                    "is_favorite": false,
                    "status": "string",
                    "conditions": [
                        {
                            "type": "string",
                            "url": "string"
                        }
                    ],
                    "flag": "basket"
                },
                {
                    "id": 0,
                    "name": "string",
                    "type": "string",
                    "default_price": 0,
                    "goal_source": "string",
                    "is_favorite": false,
                    "status": "string",
                    "duration": 0
                }
            ],
            "filters": [
                {
                    "id": 0,
                    "attr": "string",
                    "type": "string",
                    "value": "string",
                    "action": "string",
                    "status": "string",
                    "start_ip": "string",
                    "end_ip": "string",
                    "with_subdomains": false
                }
            ],
            "operations": [
                {
                    "id": 0,
                    "action": "string",
                    "attr": "string",
                    "value": "string",
                    "status": "string"
                }
            ],
            "grants": [
                {
                    "user_login": "string",
                    "perm": "string",
                    "created_at": "2022-12-29T18:02:01Z",
                    "comment": "string",
                    "partner_data_access": false
                },
                {
                    "user_login": "string",
                    "perm": "string",
                    "created_at": "2022-12-29T18:02:01Z",
                    "comment": "string",
                    "partner_data_access": false,
                    "access_filters": [
                        {
                            "id": 0,
                            "name": "string"
                        }
                    ]
                }
            ],
            "labels": [
                {
                    "id": 0,
                    "name": "string"
                }
            ],
            "webvisor": {
                "urls": "string",
                "arch_enabled": false,
                "arch_type": "string",
                "load_player_type": "string",
                "wv_version": 0,
                "wv_forms": false
            },
            "code_options": {
                "async": false,
                "informer": {
                    "enabled": false,
                    "type": "string",
                    "size": 0,
                    "indicator": "string",
                    "color_start": "FFFFFFFF.",
                    "color_end": "EFEFEFFF",
                    "color_text": 0,
                    "color_arrow": 0
                },
                "visor": false,
                "track_hash": false,
                "xml_site": false,
                "clickmap": false,
                "in_one_line": false,
                "ecommerce": false,
                "alternative_cdn": false,
                "ytm": false
            },
            "create_time": "2022-12-29T18:02:01Z",
            "time_zone_name": "string",
            "time_zone_offset": 0,
            "source": "string",
            "site2": {
                "site": "string"
            },
            "gdpr_agreement_accepted": false,
            "mirrors2": [
                {
                    "site": "string"
                }
            ]
        }
    ]
}

Name

Description

counters

Type: CounterBrief[]

List of counters.

rows

Type: integer<int32>

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

CounterBrief

Name	Description
activity_status	Type: string Counter traffic. Possible values: `low`: Low traffic. `high`: High traffic.
code_options	Type: CodeOptionsE Counter code settings.
create_time	Type: string<date-time> Date and time when the counter was created.
favorite	Type: boolean Whether the counter is added to favorites: 0: Not added (default). 1: Added.
filters	Type: FilterE[] List of structures with information on counter filters.
gdpr_agreement_accepted	Type: boolean Acceptance of the Yandex Metrica Data Processing Agreement. 0: Agreement not accepted (default). 1: Agreement accepted.
goals	Type: (ActionGoal or CompositeGoal or DepthGoal or EmailGoal or FileGoal or MessengerGoal or PaymentSystemGoal or PhoneGoal or SiteSearchGoal or SocialNetworkGoal or UrlGoal or VisitDurationGoal)[] List of structures with information on counter goals.
grants	Type: (CounterGrantE or AccessFiltersGrantE)[]
id	Type: integer<int32> Counter ID.
labels	Type: Label[] List of structures with information on labels. Label.
mirrors2	Type: CounterMirrorE[] List of site mirrors (domains).
name	Type: string Counter name. Min length: `0` Max length: `255`
operations	Type: OperationE[] List of structures with information on counter actions.
owner_login	Type: string Login of the counter owner.
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.
site2	Type: CounterMirrorE List of site mirrors (domains).
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.
status	Type: string Counter status. Possible values: `Active`: Counter active. `Deleted`: Counter deleted.
time_zone_name	Type: string Time zone for calculating statistics.
time_zone_offset	Type: integer<int32> 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.
webvisor	Type: WebvisorOptions Structure with information on Session Replay settings.

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.
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.

FilterE

List of structures with information on counter filters.

Name	Description
action*	Type: string Filter type: `exclude`: Exclude traffic. `include`: Leave only traffic.
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.
status*	Type: string Filter status: `active`: Filter is used. `disabled`: Filter disabled (but not deleted).
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.
end_ip	Type: string The last IP address in the range.
id	Type: integer<int32> Filter ID. Specify this parameter when changing a counter filter.
start_ip	Type: string The first IP address in the range.
value	Type: string Filter value.
with_subdomains	Type: boolean Filter by subdomain.

ActionGoal

JavaScript event.

Name	Description
name*	Type: string Goal name. Min length: `0` Max length: `255`
type*	Type: string Goal type: `url`: Pageviews. `number`: Number of views. `step`: Multi-step goal. `action`: JavaScript event. `phone`: Click on a phone number. `email`: Click on an email address. `payment_system`: Payment system. `messenger`: Click-through to a messenger. `file`: File download. `search`: Site search. `social`: Click-through to social media accounts. `visit_duration`: Session duration.
conditions	Type: GoalCondition[] List of structures with the goal conditions.
default_price	Type: number<double> Default goal cost.
flag	Type: string Goal type for Yandex Market clients: `basket`: Shopping cart, shopping cart page. `order`: Order, order confirmation page. Enum: `basket`, `order`, ``
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).
id	Type: integer<int64> 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

CompositeGoal

Multi-step goal. Used for grouping and setting the order of usual goals. 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.

Name	Description
name*	Type: string Goal name. Min length: `0` Max length: `255`
steps*	Type: ConditionalGoal[] List of steps in a multi-step goal. Min items: `0` Max items: `5`
type*	Type: string Goal type: `url`: Pageviews. `number`: Number of views. `step`: Multi-step goal. `action`: JavaScript event. `phone`: Click on a phone number. `email`: Click on an email address. `payment_system`: Payment system. `messenger`: Click-through to a messenger. `file`: File download. `search`: Site search. `social`: Click-through to social media accounts. `visit_duration`: Session duration.
default_price	Type: number<double> 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).
id	Type: integer<int64> 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

DepthGoal

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

Name	Description
depth*	Type: integer<int64> Number of pages viewed by the user. Min value: `2`
name*	Type: string Goal name. Min length: `0` Max length: `255`
type*	Type: string Goal type: `url`: Pageviews. `number`: Number of views. `step`: Multi-step goal. `action`: JavaScript event. `phone`: Click on a phone number. `email`: Click on an email address. `payment_system`: Payment system. `messenger`: Click-through to a messenger. `file`: File download. `search`: Site search. `social`: Click-through to social media accounts. `visit_duration`: Session duration.
default_price	Type: number<double> 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).
id	Type: integer<int64> 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

EmailGoal

Clicks or taps on an email address.

Name	Description
name*	Type: string Goal name. Min length: `0` Max length: `255`
type*	Type: string Goal type: `url`: Pageviews. `number`: Number of views. `step`: Multi-step goal. `action`: JavaScript event. `phone`: Click on a phone number. `email`: Click on an email address. `payment_system`: Payment system. `messenger`: Click-through to a messenger. `file`: File download. `search`: Site search. `social`: Click-through to social media accounts. `visit_duration`: Session duration.
conditions	Type: GoalCondition[] List of structures with the goal conditions.
default_price	Type: number<double> Default goal cost.
flag	Type: string Goal type for Yandex Market clients: `basket`: Shopping cart, shopping cart page. `order`: Order, order confirmation page. Enum: `basket`, `order`, ``
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).
id	Type: integer<int64> 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

FileGoal

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

Name	Description
name*	Type: string Goal name. Min length: `0` Max length: `255`
type*	Type: string Goal type: `url`: Pageviews. `number`: Number of views. `step`: Multi-step goal. `action`: JavaScript event. `phone`: Click on a phone number. `email`: Click on an email address. `payment_system`: Payment system. `messenger`: Click-through to a messenger. `file`: File download. `search`: Site search. `social`: Click-through to social media accounts. `visit_duration`: Session duration.
conditions	Type: GoalCondition[] List of structures with the goal conditions.
default_price	Type: number<double> Default goal cost.
flag	Type: string Goal type for Yandex Market clients: `basket`: Shopping cart, shopping cart page. `order`: Order, order confirmation page. Enum: `basket`, `order`, ``
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).
id	Type: integer<int64> 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

MessengerGoal

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

Name	Description
name*	Type: string Goal name. Min length: `0` Max length: `255`
type*	Type: string Goal type: `url`: Pageviews. `number`: Number of views. `step`: Multi-step goal. `action`: JavaScript event. `phone`: Click on a phone number. `email`: Click on an email address. `payment_system`: Payment system. `messenger`: Click-through to a messenger. `file`: File download. `search`: Site search. `social`: Click-through to social media accounts. `visit_duration`: Session duration.
conditions	Type: GoalCondition[] List of structures with the goal conditions.
default_price	Type: number<double> Default goal cost.
flag	Type: string Goal type for Yandex Market clients: `basket`: Shopping cart, shopping cart page. `order`: Order, order confirmation page. Enum: `basket`, `order`, ``
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).
id	Type: integer<int64> 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

PaymentSystemGoal

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

Name	Description
name*	Type: string Goal name. Min length: `0` Max length: `255`
type*	Type: string Goal type: `url`: Pageviews. `number`: Number of views. `step`: Multi-step goal. `action`: JavaScript event. `phone`: Click on a phone number. `email`: Click on an email address. `payment_system`: Payment system. `messenger`: Click-through to a messenger. `file`: File download. `search`: Site search. `social`: Click-through to social media accounts. `visit_duration`: Session duration.
default_price	Type: number<double> 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).
id	Type: integer<int64> 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

PhoneGoal

Clicks or taps on the phone number.

Name	Description
name*	Type: string Goal name. Min length: `0` Max length: `255`
type*	Type: string Goal type: `url`: Pageviews. `number`: Number of views. `step`: Multi-step goal. `action`: JavaScript event. `phone`: Click on a phone number. `email`: Click on an email address. `payment_system`: Payment system. `messenger`: Click-through to a messenger. `file`: File download. `search`: Site search. `social`: Click-through to social media accounts. `visit_duration`: Session duration.
conditions	Type: GoalCondition[] List of structures with the goal conditions.
default_price	Type: number<double> Default goal cost.
flag	Type: string Goal type for Yandex Market clients: `basket`: Shopping cart, shopping cart page. `order`: Order, order confirmation page. Enum: `basket`, `order`, ``
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).
hide_phone_number	Type: boolean Hide the phone number on desktop devices.
id	Type: integer<int64> 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

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.

Name	Description
name*	Type: string Goal name. Min length: `0` Max length: `255`
type*	Type: string Goal type: `url`: Pageviews. `number`: Number of views. `step`: Multi-step goal. `action`: JavaScript event. `phone`: Click on a phone number. `email`: Click on an email address. `payment_system`: Payment system. `messenger`: Click-through to a messenger. `file`: File download. `search`: Site search. `social`: Click-through to social media accounts. `visit_duration`: Session duration.
conditions	Type: GoalCondition[] List of structures with the goal conditions.
default_price	Type: number<double> Default goal cost.
flag	Type: string Goal type for Yandex Market clients: `basket`: Shopping cart, shopping cart page. `order`: Order, order confirmation page. Enum: `basket`, `order`, ``
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).
id	Type: integer<int64> 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

SocialNetworkGoal

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

Name	Description
name*	Type: string Goal name. Min length: `0` Max length: `255`
type*	Type: string Goal type: `url`: Pageviews. `number`: Number of views. `step`: Multi-step goal. `action`: JavaScript event. `phone`: Click on a phone number. `email`: Click on an email address. `payment_system`: Payment system. `messenger`: Click-through to a messenger. `file`: File download. `search`: Site search. `social`: Click-through to social media accounts. `visit_duration`: Session duration.
conditions	Type: GoalCondition[] List of structures with the goal conditions.
default_price	Type: number<double> Default goal cost.
flag	Type: string Goal type for Yandex Market clients: `basket`: Shopping cart, shopping cart page. `order`: Order, order confirmation page. Enum: `basket`, `order`, ``
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).
id	Type: integer<int64> 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

UrlGoal

Pageviews. Achieved when at least one condition is met.

Name	Description
name*	Type: string Goal name. Min length: `0` Max length: `255`
type*	Type: string Goal type: `url`: Pageviews. `number`: Number of views. `step`: Multi-step goal. `action`: JavaScript event. `phone`: Click on a phone number. `email`: Click on an email address. `payment_system`: Payment system. `messenger`: Click-through to a messenger. `file`: File download. `search`: Site search. `social`: Click-through to social media accounts. `visit_duration`: Session duration.
conditions	Type: GoalCondition[] List of structures with the goal conditions.
default_price	Type: number<double> Default goal cost.
flag	Type: string Goal type for Yandex Market clients: `basket`: Shopping cart, shopping cart page. `order`: Order, order confirmation page. Enum: `basket`, `order`, ``
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).
id	Type: integer<int64> 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

VisitDurationGoal

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

Name	Description
name*	Type: string Goal name. Min length: `0` Max length: `255`
type*	Type: string Goal type: `url`: Pageviews. `number`: Number of views. `step`: Multi-step goal. `action`: JavaScript event. `phone`: Click on a phone number. `email`: Click on an email address. `payment_system`: Payment system. `messenger`: Click-through to a messenger. `file`: File download. `search`: Site search. `social`: Click-through to social media accounts. `visit_duration`: Session duration.
default_price	Type: number<double> Default goal cost.
duration	Type: integer<int32> Session duration in seconds. Min value: `1`
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).
id	Type: integer<int64> 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

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.
comment	Type: string Custom comment. The maximum number of characters is 255. Min length: `0` Max length: `255`
created_at	Type: string<date-time> Date when the permission was granted in YYYY-MM-DD'T'hh:mm:ssZ format.
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`).

AccessFiltersGrantE

Name	Description
access_filters*	Type: AccessFiltersShortE[] List of access filters granted to the user. Min items: `1` Max items: `1`
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.
comment	Type: string Custom comment. The maximum number of characters is 255. Min length: `0` Max length: `255`
created_at	Type: string<date-time> Date when the permission was granted in YYYY-MM-DD'T'hh:mm:ssZ format.
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`).

Label

Label.

Name

Description

Type: integer<int32>

Label ID.

name

Type: string

Label name.

Min length: 0

Max length: 255

CounterMirrorE

List of site mirrors (domains).

Name

Description

site*

Type: string

Full site domain.

Min length: 0

Max length: 255

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.
attr*	Type: string Field for filtering: `referer`: Referrer. `url`: Page URL.
status*	Type: string Action status: `active`: Action is used. `disabled`: Action is disabled (but not deleted).
id	Type: integer<int32> Action ID (needs to be specified while changing a counter action).
value	Type: string Value for replacement.

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.
load_player_type	Type: string Loading pages in the player: `proxy`: As an anonymous user. `on_your_behalf`: As you.
urls	Type: string List of pages for saving. Min length: `0` Max length: `2000`
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<int32> Session Replay version.

InformerOptionsE

Informer settings.

Name	Description
color_arrow	Type: integer<int32> 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<int32> 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.
size	Type: integer<int32> 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).

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).

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.

ConditionalGoal

List of steps in a multi-step goal.

Name	Description
name*	Type: string Goal name. Min length: `0` Max length: `255`
type*	Type: string Goal type: `url`: Pageviews. `number`: Number of views. `step`: Multi-step goal. `action`: JavaScript event. `phone`: Click on a phone number. `email`: Click on an email address. `payment_system`: Payment system. `messenger`: Click-through to a messenger. `file`: File download. `search`: Site search. `social`: Click-through to social media accounts. `visit_duration`: Session duration.
conditions	Type: GoalCondition[] List of structures with the goal conditions.
default_price	Type: number<double> Default goal cost.
flag	Type: string Goal type for Yandex Market clients: `basket`: Shopping cart, shopping cart page. `order`: Order, order confirmation page.
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).
id	Type: integer<int64> 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

AccessFiltersShortE

List of access filters granted to the user.

Name

Description

Type: integer<int32>

Access filter ID.

name

Type: string

Access filter name.

Was the article helpful?

Deleting a counter

Creating a counter