Документация
Справочник разработчика
API управления
Управление клиентами Директа
API отчетов v1
Группировки
Клики
Параметры посетителей

Создание сегмента

Создает сегмент с заданными параметрами. Сегмент, созданный с помощью API, не отображается в веб-интерфейсе Яндекс.Метрики. Для одного счетчика API позволяет создать до 500 сегментов, как и веб-интерфейс. Таким образом, общее количество сегментов может составлять 1 000.

Краткое содержание

Синтаксис запроса

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

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

В теле запроса


{
    "segment
[no-highlight[

Описание

Сегмент.

]no-highlight]
" : { "name
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "expression
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "segment_source
[no-highlight[

Описание

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

]no-highlight]
" : < segment_source > } }
ПараметрыОписание
segment Сегмент.
segment
name Название сегмента.
expression Выражение, которое соответствует значению параметра filters.
segment_source Источник сегмента. Указывает на способ его создания. Принимает значение api — используются сегменты, созданные с помощью API.

Пример запроса

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

Формат ответа


{
    "segment
[no-highlight[

Описание

Сегмент.

]no-highlight]
" : { "segment_id
[no-highlight[

Описание

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

]no-highlight]
" : < integer > , "counter_id
[no-highlight[

Описание

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

]no-highlight]
" : < integer > , "name
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "expression
[no-highlight[

Описание

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

]no-highlight]
" : < string > , "segment_source
[no-highlight[

Описание

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

]no-highlight]
" : < segment_source > } }
ПараметрыОписание
segment Сегмент.
segment
segment_id Идентификатор сегмента.
counter_id Идентификатор счетчика.
name Название сегмента.
expression Выражение, которое соответствует значению параметра filters.
segment_source Источник сегмента. Указывает на способ его создания. Принимает значение api — используются сегменты, созданные с помощью API.