Creating a counter

counter

Type: CounterFull

Counter.

{
  "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": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "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,
    "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",
    "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,
  "update_time": "example",
  "delete_time": "example",
  "code": "example",
  "filter_robots": 1,
  "currency": 0,
  "currency_code": "example",
  "visit_threshold": 1800,
  "max_goals": 0,
  "max_operations": 0,
  "max_filters": 0,
  "features": [
    "example"
  ],
  "publisher_options": {
    "enabled": true,
    "schema": "example",
    "schema_options": [
      "example"
    ]
  },
  "total_geo_points_count": 0,
  "selected_geo_points_count": 0,
  "vendor_id": 0,
  "site2": {
    "site": "example",
    "domain": "example",
    "status": "example"
  },
  "gdpr_agreement_accepted": 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"
    }
  ],
  "autogoals_enabled": true,
  "ecommerce_deduplicator_enabled": true,
  "counter_flags": {
    "counter_id": 0,
    "use_in_benchmarks": true,
    "direct_allow_use_goals_without_access": true,
    "incognito": "example",
    "collect_first_party_data": true,
    "collect_masked_first_party_data": true,
    "statistics_over_site": true,
    "measurement_enabled": true,
    "vendor_data": true,
    "allow_use_data_to_collect_feedback": true
  },
  "measurement_tokens": [
    "example"
  ]
}

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.

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

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

field

Type: string

What the goal applies to.

Example: example

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[]

[
  {
    "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

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

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.

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

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

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

id

Type: integer

Access filter ID.

name

Type: string

Access filter name.

Example: example

id

Type: integer

Label ID.

name

Type: string

Label name.

Min length: 0

Max length: 255

Example: example

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.

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

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.

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

enabled

Type: boolean

Collection of content analytics data. To start collecting statistics, add the markup to your site.

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

schema

Type: string

Available site markup options. Possible values:

• microdata
• json_ld
• opengraph

Example: example

schema_options

Type: string[]

[
  "example"
]

site

Type: string

Full site domain.

Min length: 0

Max length: 255

Example: example

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 128

Example: example

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 128

Example: example

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 1000

Example: example

collect_first_party_data

Type: boolean

Use advanced tracking settings. Enabling this option will allow Yandex Metrica to use the contact information entered by users on the site to enhance advertising algorithms and more accurately analyze user behavior. This helps you get better results from your ad campaigns and learn more about user behavior, even if they use browsers that limit cross-site cookies (third-party cookies), such as Safari and Mozilla Firefox.

direct_allow_use_goals_without_access

Type: boolean

Allow optimizing campaigns for goals without access to the counter. If someone other than you manages your Yandex Direct ad campaigns, such as an agency or a setup expert, you can grant them permission to use existing goals in Yandex Metrica. If the counter was created recently, the option is enabled by default. For more information, see Help.

measurement_enabled

Type: boolean

Enable the Measurement Protocol option. The Measurement Protocol is an API for sending data about user interactions directly to Yandex Metrica servers via HTTP requests.

use_in_benchmarks

Type: boolean

Get access to market reports. The option allows Yandex Metrica to use aggregated anonymized counter data to build market analytics reports. The collected data will provide you with insights into your business's performance within the market. If the counter was created recently, the option is enabled by default.

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

activity_status

Type: string

Counter traffic. Possible values:

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

Example: example

autogoals_enabled

Type: boolean

Enabling automatic goals. Possible values:

• true: Option enabled.
• false: Option disabled.

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

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

code

Type: string

HTML ad tag.

Example: example

code_options

Type: CodeOptionsE

Counter code settings.

{
  "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",
  "ssr": true
}

counter_flags

Type: CounterFlags

Data security and usage.

{
  "counter_id": 0,
  "use_in_benchmarks": true,
  "direct_allow_use_goals_without_access": true,
  "incognito": "example",
  "collect_first_party_data": true,
  "collect_masked_first_party_data": true,
  "statistics_over_site": true,
  "measurement_enabled": true,
  "vendor_data": true,
  "allow_use_data_to_collect_feedback": 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).

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

delete_time

Type: string

Time of counter deletion.

Example: example

favorite

Type: boolean

Whether the counter is added to favorites:

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

filter_robots

Type: integer

Filtering of robots:

• 1: Filter robots by strict rules only (default).
• 2: Filter robots by strict rules and by behavior.

Min value: 1

Max value: 2

filters

Type: FilterE[]

[
  {
    "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

List of structures with information on counter goals.

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

grants

id

Type: integer

Counter ID.

labels

Type: Label[]

List of structures with information on labels.

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

measurement_tokens

Type: string[]

[
  "example"
]

mirrors2

Type: CounterMirrorE[]

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

name

Type: string

Counter name.

Min length: 0

Max length: 255

Example: example

operations

Type: OperationE[]

[
  {
    "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

publisher_options

Type: PublisherOptions

Structure with information on content analytics settings.

{
  "enabled": true,
  "schema": "example",
  "schema_options": [
    "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).

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

site2

Type: CounterMirrorE

List of site mirrors (domains).

{
  "site": "example",
  "domain": "example",
  "status": "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

update_time

Type: string

Time of the last counter update.

Example: example

vendor_id

Type: integer

visit_threshold

Type: integer

Session timeout in seconds.

Default: 1800

Min value: 1800

Max value: 21600

webvisor

Type: WebvisorOptions

Structure with information on Session Replay settings.

{
  "urls": "example",
  "arch_enabled": true,
  "arch_type": "example",
  "load_player_type": "example",
  "wv_version": 0,
  "wv_forms": true
}

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 1000

Example: example

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 1000

Example: example

code

Type: string

Example: example

custom

Type: string

Min length: 0

Max length: 1000

Example: example