Creating a segment

Creates a segment with set parameters. A segment created via the API won't appear in the Yandex Metrica web interface. The API allows creating up to 500 segments for one counter, just like the web interface. This means the total number of segments can be 1000.

Request

POST

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

Path parameters

Name

Description

counterId

Type: integer

Tag ID.

Body

application/json
{
  "segment": {
    "segment_id": 0,
    "counter_id": 0,
    "name": "example",
    "expression": "example",
    "status": "example",
    "segment_source": "example",
    "create_time": "2025-01-01T00:00:00Z"
  }
}

Name

Description

segment

Type: Segment

Segment.

Example
{
  "segment_id": 0,
  "counter_id": 0,
  "name": "example",
  "expression": "example",
  "status": "example",
  "segment_source": "example",
  "create_time": "2025-01-01T00:00:00Z"
}

Segment

Segment.

Name

Description

counter_id

Type: integer

Tag ID.

create_time

Type: string<date-time>

Segment creation time.

Example: 2025-01-01T00:00:00Z

expression

Type: string

An expression that matches the value of the filters parameter.

Min length: 1

Max length: 65535

Example: example

name

Type: string

Segment name.

Min length: 1

Max length: 255

Example: example

segment_id

Type: integer

Segment ID.

segment_source

Type: string

Segment source. Shows how this segment was created. Accepts the value api. API-created segments are used.

Example: example

status

Type: string

Segment status. Possible values:

  • active: Active segment.
  • deleted: Deleted segment.

Example: example

Example
{
  "segment_id": 0,
  "counter_id": 0,
  "name": "example",
  "expression": "example",
  "status": "example",
  "segment_source": "example",
  "create_time": "2025-01-01T00:00:00Z"
}

Responses

200 OK

OK

Body

application/json
{
  "segment": {
    "segment_id": 0,
    "counter_id": 0,
    "name": "example",
    "expression": "example",
    "status": "example",
    "segment_source": "example",
    "create_time": "2025-01-01T00:00:00Z"
  }
}

Name

Description

segment

Type: Segment

Segment.

Example
{
  "segment_id": 0,
  "counter_id": 0,
  "name": "example",
  "expression": "example",
  "status": "example",
  "segment_source": "example",
  "create_time": "2025-01-01T00:00:00Z"
}