Description of the "goal" type

Type for the goal description.

Response format

JavaScript event.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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

  • regexp: Matches a regular expression.
  • contain: Contains.
  • start: Starts with.
  • exact: Matches exactly.
  • action: Special type of conditions for the JavaScript event goals.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.
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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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

  • regexp: Matches a regular expression.
  • contain: Contains.
  • start: Starts with.
  • exact: Matches exactly.
  • action: Special type of conditions for the JavaScript event goals.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.

Response format

Multi-step goal.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "is_retargeting" :  < boolean > ,
    "steps" : [ {
        "id" :  < int > ,
        "name" :  < string > ,
        "type" :  < goal_type > ,
        "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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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

Possible values

  • regexp: Matches a regular expression.
  • contain: Contains.
  • start: Starts with.
  • exact: Matches exactly.
  • action: Special type of conditions for the JavaScript event goals.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.
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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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

Possible values

  • regexp: Matches a regular expression.
  • contain: Contains.
  • start: Starts with.
  • exact: Matches exactly.
  • action: Special type of conditions for the JavaScript event goals.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.

Response format

Page depth.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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

  • regexp: Matches a regular expression.
  • contain: Contains.
  • start: Starts with.
  • exact: Matches exactly.
  • action: Special type of conditions for the JavaScript event goals.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.
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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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

  • regexp: Matches a regular expression.
  • contain: Contains.
  • start: Starts with.
  • exact: Matches exactly.
  • action: Special type of conditions for the JavaScript event goals.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.

Response format

Call.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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

Click on email.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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

  • exact: Matches exactly.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.
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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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

  • exact: Matches exactly.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.

Response format

Click on phone number.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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

  • exact: Matches exactly.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.
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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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

  • exact: Matches exactly.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.

Response format

Form submission.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "type" :  < goal_type > ,
    "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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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:
  • form_id: Form ID.
  • form_name: Form name.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.
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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
is_retargeting Whether the goal is retargeting.

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:
  • form_id: Form ID.
  • form_name: Form name.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.

Response format

Click-through to a messenger.


{
    "id" :  < int > ,
    "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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
default_price Revenue by goal.
is_retargeting Whether the goal is retargeting.

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

  • messenger: Click-through to a messenger.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.
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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
default_price Revenue by goal.
is_retargeting Whether the goal is retargeting.

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

  • messenger: Click-through to a messenger.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.

Response format

Button click.


{
    "id" :  < int > ,
    "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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
default_price Revenue by goal.
is_retargeting Whether the goal is retargeting.

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.

These values aren't public and are used for the service's internal mechanics.

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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.
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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
default_price Revenue by goal.
is_retargeting Whether the goal is retargeting.

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.

These values aren't public and are used for the service's internal mechanics.

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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.

Response format

Site search.


{
    "id" :  < int > ,
    "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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
default_price Revenue by goal.
is_retargeting Whether the goal is retargeting.

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:
  • search: Site search.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.
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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
default_price Revenue by goal.
is_retargeting Whether the goal is retargeting.

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:
  • search: Site search.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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.

Response format

File download.


{
    "id" :  < int > ,
    "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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
default_price Revenue by goal.
is_retargeting Whether the goal is retargeting.

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:
  • file: File download.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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. For the available file types and formats, see Help.
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

  • number: Number of views.
  • action: JavaScript event.
  • step: Multi-step goal.
  • url: Page URL match.
  • email: Click on email.
  • phone: Click on phone number.
  • form: Form submission.
  • messenger: Click-through to a messenger.
  • button: Button click.
  • file: File download.
  • search: Site search.
default_price Revenue by goal.
is_retargeting Whether the goal is retargeting.

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:
  • file: File download.
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.
“Form submission”
ID or name of the form to be tracked.
“ Open messenger”
Name of the messenger retrieved by the method GET management/v1/messengers, or the all_messengers value.
“ Button click”
A link followed by the user when clicking a button or another clickable element.
“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. For the available file types and formats, see Help.