Изменение сегмента

Изменяет указанный сегмент. Сегмент, измененный с помощью API, не отображается в веб-интерфейсе Яндекс.Метрики

Request

PUT

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

Path parameters

Name

Description

counterId

Type: integer

Идентификатор счетчика.

segmentId

Type: integer

Идентификатор сегмента, который вы хотите обновить.

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

Сегмент.

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

Segment

Сегмент.

Name

Description

counter_id

Type: integer

Идентификатор счетчика.

create_time

Type: string<date-time>

Время создания сегмента.

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

expression

Type: string

Выражение, которое соответствует значению параметра filters.

Min length: 1

Max length: 65535

Example: example

name

Type: string

Название сегмента.

Min length: 1

Max length: 255

Example: example

segment_id

Type: integer

Идентификатор сегмента.

segment_source

Type: string

Источник сегмента. Указывает на способ его создания. Принимает значение api — используются сегменты, созданные с помощью API.

Example: example

status

Type: string

Статус сегмента. Возможные значения:

  • active — сегмент активен.
  • deleted — сегмент удален.

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

Сегмент.

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