Информация о фильтре

Внимание.

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

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

Возвращает информацию об указанном фильтре счетчика.

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

counterId — идентификатор счетчика, информацию о фильтре которого вы хотите получить.

filterId — идентификатор фильтра, информацию о котором вы хотите получить.

GET https://api-metrika.yandex.net/management/v1/counter/{counterId}/filter/{filterId}
 ? [callback=<string>]
Query-параметры
callbackФункция обратного вызова, которая обрабатывает ответ API.

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


{
    "filter" : {
        "id" :  < int > ,
        "attr" :  < filter_attribute > ,
        "type" :  < filter_type > ,
        "value" :  < string > ,
        "action" :  < filter_action > ,
        "status" :  < filter_status > ,
        "start_ip" :  < string > ,
        "end_ip" :  < string > ,
        "with_subdomains" :  < boolean > 
    }
}
ПараметрыОписание
filterФильтр.
filter
id

Идентификатор фильтра. Укажите данный параметр при изменении фильтра счетчика

attrТип данных, к которым применяется фильтр.

Возможные значения:

  • referer — реферер;
  • uniq_id — специальный атрибут для фильтра «не учитывать мои визиты».
  • client_ip — IP-адрес;
  • title — заголовок страницы;
  • url — URL страницы;
typeОтношение или действие для фильтра.

Возможные значения:

  • equal — равно;
  • contain — содержит;
  • me — мои посещения, используется только с типом данных attr = uniq_id;
  • start — начинается с;
  • interval — в интервале, используется только с типом данных «IP-адрес» (attr = client_ip);
  • only_mirrors — только сайт и зеркала, используется только для типа данных «URL страницы» (attr = url) и типа фильтра «оставить только трафик» (action = include), а также при условии, что для счетчика заданы зеркала.
valueЗначение фильтра.
actionТип фильтра.

Возможные значения:

  • include — оставить только трафик.
  • exclude — исключить трафик;
statusСтатус фильтра.

Возможные значения:

  • active — фильтр используется;
  • disabled — фильтр отключен (без удаления).
start_ipПервый IP-адрес диапазона.
end_ipПоследний IP-адрес диапазона.
with_subdomainsФильтровать по поддоменам.