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

Внимание.

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

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

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

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

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

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

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

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


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

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

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

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


{
    "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.