Description of the "goal" type

Type for the goal description.

Response format

JavaScript event.


{
    "id" :  < long > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "default_price" :  < double > ,
    "is_retargeting" :  < boolean > ,
    "goal_source" :  < goal_source > ,
    "flag" :  < goal_market_type > ,
    "conditions" : [ {
        "type" :  < goal_condition_type > ,
        "url" :  < string > 
    }, ... ]
}
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.

Response format

Multi-step goal.


{
    "id" :  < long > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "default_price" :  < double > ,
    "is_retargeting" :  < boolean > ,
    "goal_source" :  < goal_source > ,
    "steps" : [ {
        "id" :  < long > ,
        "name" :  < string > ,
        "type" :  < goal_type > ,
        "default_price" :  < double > ,
        "is_retargeting" :  < boolean > ,
        "goal_source" :  < goal_source > ,
        "flag" :  < goal_market_type > ,
        "conditions" : [ {
            "type" :  < goal_condition_type > ,
            "url" :  < string > 
        }, ... ]
    }, ... ]
}
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
steps List of steps in a multi-step goal.
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
steps List of steps in a multi-step goal.
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.

Response format

Page depth.


{
    "id" :  < long > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "default_price" :  < double > ,
    "is_retargeting" :  < boolean > ,
    "goal_source" :  < goal_source > ,
    "depth" :  < long > 
}
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
depth Number of pages viewed by the user.
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
depth Number of pages viewed by the user.

Response format

Pageviews.


{
    "id" :  < long > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "default_price" :  < double > ,
    "is_retargeting" :  < boolean > ,
    "goal_source" :  < goal_source > ,
    "flag" :  < goal_market_type > ,
    "conditions" : [ {
        "type" :  < goal_condition_type > ,
        "url" :  < string > 
    }, ... ]
}
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.

Response format

Clicks or taps on an email address.


{
    "id" :  < long > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "default_price" :  < double > ,
    "is_retargeting" :  < boolean > ,
    "goal_source" :  < goal_source > ,
    "flag" :  < goal_market_type > ,
    "conditions" : [ {
        "type" :  < goal_condition_type > ,
        "url" :  < string > 
    }, ... ]
}
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.

Response format

Clicks or taps on a phone number.


{
    "id" :  < long > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "default_price" :  < double > ,
    "is_retargeting" :  < boolean > ,
    "goal_source" :  < goal_source > ,
    "flag" :  < goal_market_type > ,
    "conditions" : [ {
        "type" :  < goal_condition_type > ,
        "url" :  < string > 
    }, ... ],
    "hide_phone_number" :  < boolean > 
}
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
hide_phone_number Hide the phone number on desktops.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
hide_phone_number Hide the phone number on desktops.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.

Response format

Payment systems.


{
    "id" :  < long > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "default_price" :  < double > ,
    "is_retargeting" :  < boolean > ,
    "goal_source" :  < goal_source > 
}
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

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

Response format

Open messenger


{
    "id" :  < long > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "default_price" :  < double > ,
    "is_retargeting" :  < boolean > ,
    "goal_source" :  < goal_source > ,
    "flag" :  < goal_market_type > ,
    "conditions" : [ {
        "type" :  < goal_condition_type > ,
        "url" :  < string > 
    }, ... ]
}
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.

Response format

File downloads


{
    "id" :  < long > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "default_price" :  < double > ,
    "is_retargeting" :  < boolean > ,
    "goal_source" :  < goal_source > ,
    "flag" :  < goal_market_type > ,
    "conditions" : [ {
        "type" :  < goal_condition_type > ,
        "url" :  < string > 
    }, ... ]
}
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.

Response format

Site search


{
    "id" :  < long > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "default_price" :  < double > ,
    "is_retargeting" :  < boolean > ,
    "goal_source" :  < goal_source > ,
    "flag" :  < goal_market_type > ,
    "conditions" : [ {
        "type" :  < goal_condition_type > ,
        "url" :  < string > 
    }, ... ]
}
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.

Response format

Click-through to social network


{
    "id" :  < long > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "default_price" :  < double > ,
    "is_retargeting" :  < boolean > ,
    "goal_source" :  < goal_source > ,
    "flag" :  < goal_market_type > ,
    "conditions" : [ {
        "type" :  < goal_condition_type > ,
        "url" :  < string > 
    }, ... ]
}
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.
Parameters Description
id ID of the goal. Specify this parameter when changing and deleting a tag goal.
name Goal name.
type Goal type.

Possible values

  • url: Pageviews.
  • number: Number of views.
  • step: Multi-step goal.
  • action: JavaScript event.
  • phone: Click on phone number.
  • email: Click on email.
  • payment_system: Payment system.
  • messenger: Click-through to a messenger.
  • file: File download.
  • search: Site search.
  • social: Click-through to social network.
default_price Default goal cost.
is_retargeting Whether the goal is retargeting. This parameter is deprecated and no longer used.

Possible values

  • 0: False (default).
  • 1: True.
goal_source Indicates how the goal was created.

Possible values

  • 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).
flag Goal type for Yandex Market clients.

Possible values

  • basket: “Shopping cart”, shopping cart page.
  • order: “Order”, order confirmation page.
conditions List of structures with the goal conditions.
Parameters Description
type Condition type.

Possible values

  • contain: Contains.
  • exact: Matches exactly.
  • start: Starts with.
  • regexp: Matches a regular expression.
  • action: Special type of condition for the "JavaScript event" goals.
  • messenger: Flag for "Open messenger" goals.
  • all_files : Downloading any file for "File downloads" goals.
  • file: Downloading a specific file for "File downloads" goals.
  • search: Attribute for "Site search" goals.
  • all_social: Special type of condition for social goals (all social networks).
  • social: Special type of condition 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

The value depends on the goal type:

“Pageviews”
URL to page or page section 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 messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“Site search”
GET parameter used for searching on the site. Yandex Metrica automatically recognizes the q, text, query, or search parameters. If the site uses a different parameter, specify it in the request.
“File download”
File name — for example, example.pdf. The value can be empty if you need to track all the files downloaded on the site.
“Click-through to social network”
Name of the social network obtained via the GET management/v1/social_networks method, or the all_social value.