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

Внимание.

Передача авторизационного токена в параметрах URL перестанет работать 13 февраля 2019 года. Чтобы продолжить работу с API Метрики, настройте авторизацию по токену в HTTP-заголовке.

23 января, 30 января и 6 февраля 2019 года запланировано профилактическое отключение устаревшего способа авторизации — в эти дни он будет временно отключен.

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

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

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

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

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


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

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

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

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


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