Создание сегмента
Создает сегмент с заданными параметрами. Сегмент, созданный с помощью API, не отображается в веб-интерфейсе Яндекс.Метрики. Для одного счетчика API позволяет создать до 500 сегментов, как и веб-интерфейс. Таким образом, общее количество сегментов может составлять 1 000.
Request
POST
https://api-metrika.yandex.net/management/v1/counter/{counterId}/apisegment/segments
Path parameters
|
Name |
Description |
|
counterId |
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
Сегмент.
|
Name |
Description |
|
counter_id |
Type: integer Идентификатор счетчика. |
|
create_time |
Type: string<date-time> Время создания сегмента. Example: |
|
expression |
Type: string Выражение, которое соответствует значению параметра Min length: Max length: Example: |
|
name |
Type: string Название сегмента. Min length: Max length: Example: |
|
segment_id |
Type: integer Идентификатор сегмента. |
|
segment_source |
Type: string Источник сегмента. Указывает на способ его создания. Принимает значение Example: |
|
status |
Type: string Статус сегмента. Возможные значения:
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
|