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

Изменение фильтра

Изменяет настройки указанного фильтра счетчика.

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

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

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

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

PUT https://api-metrika.yandex.ru/management/v1/counter/{counterId}/filter/{filterId}

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


{
    "filter
[no-highlight[

Описание

Фильтр.

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

Описание

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

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

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

]no-highlight]
" : < filter_attribute > , "type
[no-highlight[

Описание

Отношение или действие для фильтра.

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

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

]no-highlight]
" : < filter_type > , "value
[no-highlight[

Описание

Значение фильтра.

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

Описание

Тип фильтра.

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

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

]no-highlight]
" : < filter_action > , "status
[no-highlight[

Описание

Статус фильтра.

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

  • active — фильтр используется;
  • disabled — фильтр отключен (без удаления).

]no-highlight]
" : < filter_status > , "with_subdomains
[no-highlight[

Описание

Фильтровать по поддоменам.

]no-highlight]
" : < boolean > } }
ПараметрыОписание
filter Фильтр.
filter
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 — фильтр отключен (без удаления).
with_subdomains Фильтровать по поддоменам.

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

PUT https://api-metrika.yandex.ru/management/v1/counter/{counterId}/filter/{filterId}

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


{
    "filter
[no-highlight[

Описание

Фильтр.

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

Описание

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

]no-highlight]
" : < int > , "attr
[no-highlight[

Описание

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

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

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

]no-highlight]
" : < filter_attribute > , "type
[no-highlight[

Описание

Отношение или действие для фильтра.

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

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

]no-highlight]
" : < filter_type > , "value
[no-highlight[

Описание

Значение фильтра.

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

Описание

Тип фильтра.

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

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

]no-highlight]
" : < filter_action > , "status
[no-highlight[

Описание

Статус фильтра.

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

  • active — фильтр используется;
  • disabled — фильтр отключен (без удаления).

]no-highlight]
" : < filter_status > , "start_ip
[no-highlight[

Описание

Первый IP-адрес диапазона.

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

Описание

Последний IP-адрес диапазона.

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

Описание

Фильтровать по поддоменам.

]no-highlight]
" : < 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 Фильтровать по поддоменам.