List of goals

Returns information about counter goals.

Request

GET

https://api-metrika.yandex.net/management/v1/counter/{counterId}/goals

Path parameters

Name

Description

counterId

Type: integer

ID of the counter for which you want to get a list of goals.

Query parameters

Name

Description

callback

Type: string

Callback function that processes the API response.

Example: ``

useDeleted

Type: boolean

Information on deleted goals.

Default: false

Responses

200 OK

OK

Body

application/json
{
  "goals": [
    {
      "id": 0,
      "name": "example",
      "type": "example",
      "default_price": 0.5,
      "is_retargeting": true,
      "goal_source": "example",
      "is_favorite": true,
      "status": "example",
      "conditions": [
        null
      ],
      "prev_goal_id": 0,
      "flag": "example"
    }
  ]
}

Name

Description

goals
Type: array
One of 13 types

  • Type: ActionGoal

    JavaScript event.

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

  • Type: ChatGoal

    Click or tap on a chat.

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

  • Type: CompositeGoal

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

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

  • Type: DepthGoal

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

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

  • Type: EmailGoal

    Clicks or taps on an email address.

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

  • Type: FileGoal

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

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

  • Type: MessengerGoal

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

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

  • Type: PaymentSystemGoal

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

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

  • Type: PhoneGoal

    Clicks or taps on the phone number.

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

  • Type: SiteSearchGoal

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

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

  • Type: SocialNetworkGoal

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

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

  • Type: UrlGoal

    Pageviews. Achieved when at least one condition is met.

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

  • Type: VisitDurationGoal

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

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

List of structures with information on counter goals.

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

GoalE

Name

Description

name

Type: string

Goal name.

Min length: 0

Max length: 255

Example: example

type

Type: string

Goal type:

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

Example: example

default_price

Type: number

Default goal cost.

goal_source

Type: string

Indicates how the goal was created:

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

Example: example

id

Type: integer

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

is_favorite

Type: boolean

Whether the goal is favorite:

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

status

Type: string

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

GoalCondition

List of structures with the goal conditions.

Name

Description

type

Type: string

Condition type:

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

Example: example

url

Type: string

The value depends on the goal type:

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

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

ActionGoal

JavaScript event.

All of 2 types

  • Type: GoalE

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

    conditions

    Type: GoalCondition[]

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

    flag

    Type: string

    Goal type for Yandex Market clients:

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

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

ChatGoalCondition

List of structures with the goal conditions.

Name

Description

field

Type: string

What the goal applies to.

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

ChatGoalConditionAnswered

All of 2 types

  • Type: ChatGoalCondition

    List of structures with the goal conditions.

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

    answered

    Type: boolean

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

ChatGoalConditionPlatform

All of 2 types

  • Type: ChatGoalCondition

    List of structures with the goal conditions.

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

    platform

    Type: string

    Chat platform. Possible values:

    • telegram
    • viber
    • whatsApp

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

ChatGoalConditionTag

All of 2 types

  • Type: ChatGoalCondition

    List of structures with the goal conditions.

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

    operator

    Type: string

    Condition type. Possible values:

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

    Example: example

    value

    Type: string

    Min length: 1

    Max length: 1024

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

ChatGoal

Click or tap on a chat.

All of 2 types

  • Type: GoalE

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

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

ConditionalGoal

List of steps in a multi-step goal.

Name

Description

name

Type: string

Goal name.

Min length: 0

Max length: 255

Example: example

type

Type: string

Goal type:

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

Example: example

conditions

Type: GoalCondition[]

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

default_price

Type: number

Default goal cost.

flag

Type: string

Goal type for Yandex Market clients:

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

Example: example

goal_source

Type: string

Indicates how the goal was created:

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

Example: example

id

Type: integer

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

is_favorite

Type: boolean

Whether the goal is favorite:

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

status

Type: string

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

CompositeGoal

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

All of 2 types

  • Type: GoalE

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

    steps

    Type: ConditionalGoal[]

    Min items: 0

    Max items: 5

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

DepthGoal

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

All of 2 types

  • Type: GoalE

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

    depth

    Type: integer

    Number of pages viewed by the user.

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

EmailGoal

Clicks or taps on an email address.

All of 2 types

  • Type: GoalE

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

    conditions

    Type: GoalCondition[]

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

    flag

    Type: string

    Goal type for Yandex Market clients:

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

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

FileGoal

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

All of 2 types

  • Type: GoalE

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

    conditions

    Type: GoalCondition[]

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

    flag

    Type: string

    Goal type for Yandex Market clients:

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

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

MessengerGoal

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

All of 2 types

  • Type: GoalE

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

    conditions

    Type: GoalCondition[]

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

    flag

    Type: string

    Goal type for Yandex Market clients:

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

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

PaymentSystemGoal

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

All of 1 type

  • Type: GoalE

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

PhoneGoal

Clicks or taps on the phone number.

All of 2 types

  • Type: GoalE

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

    conditions

    Type: GoalCondition[]

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

    flag

    Type: string

    Goal type for Yandex Market clients:

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

    Example: example

    hide_phone_number

    Type: boolean

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

SiteSearchGoal

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

All of 2 types

  • Type: GoalE

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

    conditions

    Type: GoalCondition[]

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

    flag

    Type: string

    Goal type for Yandex Market clients:

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

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

SocialNetworkGoal

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

All of 2 types

  • Type: GoalE

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

    conditions

    Type: GoalCondition[]

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

    flag

    Type: string

    Goal type for Yandex Market clients:

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

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

UrlGoal

Pageviews. Achieved when at least one condition is met.

All of 2 types

  • Type: GoalE

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

    conditions

    Type: GoalCondition[]

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

    flag

    Type: string

    Goal type for Yandex Market clients:

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

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

VisitDurationGoal

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

All of 2 types

  • Type: GoalE

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

    duration

    Type: integer

    Session duration in seconds.

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

LocationOnPage

Name

Description

path

Type: string

Location on the page

Min length: 0

Max length: 4096

Example: example

type_of_path

Type: string

Type of the specified location

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

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

Previous
Deleting a goal
Next
Creating a goal