Мониторинг поисковых запросов
Позволяет получить список поисковых запросов и URL-адресов страниц, по которым ваш сайт отображается в результатах поиска Яндекса. Данные доступны за последние две недели. Подробно о мониторинге поисковых запросов см. в Справке.
Примечание
Если вы отправите более 10 тысяч запросов в час, вы не сможете воспользоваться мониторингом в течение некоторого времени. Сообщение о превышении появится в коде ответа 429.
Формат запроса
POST https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/query-analytics/list
|
Тип: |
|
Тип: |
Заголовок запроса
При отправке запроса используйте заголовок Content-Type: application/json; charset=UTF-8
.
Формат тела запроса
{
"offset": 1,
"limit": 1,
"device_type_indicator": "ALL",
"text_indicator": "URL",
"region_ids": [
1
],
"filters": {
"text_filters": [
{
"text_indicator": "URL",
"operation": "TEXT_CONTAINS",
"value": "some string"
}
],
"statistic_filters": [
{
"statistic_field": "IMPRESSIONS",
"operation": "LESS_THAN",
"value": "some string",
"from": "some string",
"to": "some string"
}
]
},
"sort_by_date": {
"date": "some string",
"statistic_field": "IMPRESSIONS",
"by": "ASC"
}
}
<Data>
<offset>1</offset>
<limit>1</limit>
<device_type_indicator>ALL</device_type_indicator>
<text_indicator>URL</text_indicator>
<region_id>1</region_id>
<filters>
<text_filter>
<text_indicator>URL</text_indicator>
<operation>TEXT_CONTAINS</operation>
<value>some string</value>
</text_filter>
<statistic_filter>
<statistic_field>IMPRESSIONS</statistic_field>
<operation>LESS_THAN</operation>
<value>some string</value>
<from>some string</from>
<to>some string</to>
</statistic_filter>
</filters>
<sort_by_date>
<date>some string</date>
<statistic_field>IMPRESSIONS</statistic_field>
<by>ASC</by>
</sort_by_date>
</Data>
Имя |
Обязательно |
Тип |
Описание |
|
Нет |
|
Смещение списка. Минимальное значение — 0. Значение по умолчанию: 0. |
|
Нет |
|
Количество записей (1—500). Значение по умолчанию: 20. |
|
Нет |
ApiDeviceTypeIndicator |
Тип устройства. Значение по умолчанию: |
|
Нет |
|
Тип данных, по которому отображается статистика. По умолчанию принимает значение
|
|
|
Идентификаторы регионов, для которых производится мониторинг. Можно указать несколько идентификатор через запятую (например, |
|
|
Нет |
|
Фильтры. |
|
Нет |
|
Сортировка данных по дате. |
Поля внутри Filters |
|||
|
Нет |
|
Фильтры над текстом. |
|
Нет |
|
Фильтры над статистическими данными. |
Поля внутри TextFilters |
|||
|
Да, если передается |
|
Тип данных, по которому отображается статистика. Возможные значения:
|
|
Операции с URL или текстом запроса. |
||
|
|
Строка, к которой применяется операция. Используется для фильтрации поискового запроса или URL. Например, фрагмент «brand». |
|
Поля внутри StatisticFilters |
|||
|
Да, если передается |
Статистические данные, над которыми производится фильтрация. |
|
|
Целое число, которое применяется к операции. |
||
|
|
Число, с которым нужно сравнить статистическое значение. |
|
|
— |
Начало (включительно) интервала дат в формате yyyy-MM-dd. |
|
|
— |
Конец (включительно) интервала дат в формате yyyy-MM-dd. |
|
Поля внутри SortByDate |
|||
|
Да, если передается |
— |
Дата в формате yyyy-MM-dd. |
|
Статистические данные, над которыми производится фильтрация. |
||
|
Тип для описания направления сортировки. |
Индикатор |
Описание |
|
Все типы устройств. |
|
Компьютеры. |
|
Мобильные телефоны и планшеты. |
|
Мобильные телефоны. |
|
Планшеты. |
Если в запросе не задан индикатор типа устройства, по умолчанию используется значение ALL
.
Индикатор |
Описание |
|
Укажите часть текста. |
|
Укажите полностью поисковый запрос. |
|
Укажите часть текста, который не должен входить в поисковый запрос. |
Индикатор |
Описание |
|
Появление ссылки на сайт в результатах поиска Яндекса по некоторому запросу. Показом не является потенциальное появление ссылки на второй и последующих страницах результатов поиска, если пользователь эти страницы не открывал. |
|
Место, на котором появляется ссылка на сайт в поисковой выдаче Яндекса в ответ на поисковый запрос пользователя. Информация о позиции сайта может отсутствовать, если в заданный период:
В этом случае обратите внимание на «Спрос» ( |
|
Переход посетителя на сайт со страницы результатов поиска Яндекса. |
|
Отношение числа кликов на сниппет к числу его показов, измеряется в процентах. Можно сказать, что этот показатель говорит о привлекательности сниппета страницы сайта. |
|
Спрос показывает, насколько часто пользователи Яндекса задают поисковый запрос. Если сайт отображается на первой странице больше одного раза, сумма показов сайта может оказаться больше спроса. Например, для навигационных запросов, где пользователь ищет конкретный сайт, и поисковая система показывает несколько результатов с одного сайта. |
Индикатор |
Описание |
|
Меньше чем. |
|
Больше чем. |
|
Меньше или равно. |
|
Больше или равно. |
|
Равно. |
Индикатор |
Описание |
|
По возрастанию. |
|
По убыванию. |
Идентификаторы часто используемых регионов
Идентификатор |
Регион |
225 |
Россия |
11235 |
Алтайский край |
11375 |
Амурская область |
10842 |
Архангельская область |
10946 |
Астраханская область |
10645 |
Белгородская область |
10650 |
Брянская область |
10658 |
Владимирская область |
10950 |
Волгоградская область |
10853 |
Вологодская область |
10672 |
Воронежская область |
10687 |
Ивановская область |
11266 |
Иркутская область |
11013 |
Кабардино-Балкарская Республика |
10857 |
Калининградская область |
11020 |
Карачаево-Черкесская Республика |
11282 |
Кемеровская область (Кузбасс) |
10699 |
Костромская область |
10995 |
Краснодарский край |
11309 |
Красноярский край |
11158 |
Курганская область |
10705 |
Курская область |
10712 |
Липецкая область |
1 |
Москва и Московская область |
10897 |
Мурманская область |
11079 |
Нижегородская область |
10904 |
Новгородская область |
11316 |
Новосибирская область |
11318 |
Омская область |
11084 |
Оренбургская область |
10772 |
Орловская область |
11095 |
Пензенская область |
11108 |
Пермский край |
11409 |
Приморский край |
10926 |
Псковская область |
11111 |
Республика Башкортостан |
11010 |
Республика Дагестан |
11012 |
Республика Ингушетия |
11077 |
Республика Марий Эл |
11117 |
Республика Мордовия |
11021 |
Республика Северная Осетия — Алания |
11119 |
Республика Татарстан |
11029 |
Ростовская область |
10776 |
Рязанская область |
11131 |
Самарская область |
10174 |
Санкт-Петербург и Ленинградская область |
11162 |
Свердловская область |
10795 |
Смоленская область |
11069 |
Ставропольский край |
10802 |
Тамбовская область |
10819 |
Тверская область |
11353 |
Томская область |
10832 |
Тульская область |
11153 |
Ульяновская область |
11457 |
Хабаровский край |
11193 |
Ханты-Мансийский автономный округ - Югра |
11225 |
Челябинская область |
11024 |
Чеченская Республика |
11156 |
Чувашская Республика |
10841 |
Ярославская область |
Формат ответа
Примеры
JSONXML
{ "count": 5175, "text_indicator_to_statistics": [ { "text_indicator": { "type": "URL", "value": "some text" }, "statistics": [ { "date": "2023-04-15", "field": "CLICKS", "value": 7.0 }, { "date": "2023-04-15", "field": "POSITION", "value": 4.0 }, { "date": "2023-04-15", "field": "IMPRESSIONS", "value": 8595.0 }, { "date": "2023-04-15", "field": "CTR", "value": 0.0 }, ...
<Data> <count>5175</count> <text_indicator_to_statistic> <text_indicator> <type>URL</type> <value>some text</value> </text_indicator> <statistic> <date>2023-04-15</date> <field>CLICKS</field> <value>7.0</value> </statistic> <statistic> <date>2023-04-15</date> <field>POSITION</field> <value>4.0</value> </statistic> <statistic> <date>2023-04-15</date> <field>IMPRESSIONS</field> <value>8595.0</value> </statistic> ...
Имя |
Обязательный |
Тип |
Описание |
|
Да |
|
Общее количество доступных данных. |
|
Да |
|
|
Поля внутри TextIndicatorToStatistics |
|||
|
Да |
|
|
|
Да |
|
|
Поля внутри TextIndicator |
|||
|
Да |
|
Возможные значения:
|
|
Да |
|
Поисковый запрос или URL страницы сайта. |
Поля внутри Statistics |
|||
|
Да |
— |
Дата в формате yyyy-MM-dd, за которую отображается статистика. |
|
Да |
Тип показателя. |
|
|
Да |
|
Значение показателя. |
Коды ответа
Чтобы посмотреть структуру ответа подробнее, нажмите на причину.
Код |
Причина |
Описание |
200 |
OK |
|
400 |
Тело запроса не прошло валидацию. JSON
XML
|
|
400 |
Передан неверный параметр. JSON
XML
|
|
400 |
Передан неправильный URL. JSON
XML
|
|
403 |
ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже JSON
XML
|
|
404 |
Не подтверждены права на управление сайтом. JSON
XML
|
|
404 |
Сайт не проиндексирован. JSON
XML
|
|
404 |
Данные о сайте еще не загружены в Яндекс Вебмастер. JSON
XML
|
|
429 |
Отправлено более 10 тысяч запросов на домен в час. Поэтому вы не сможете использовать метод /user/{user-id}/hosts/{host-id}/query-analytics/list/ в течение некоторого времени. JSON
XML
|
Узнайте больше
Тип: int64
. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
Тип: host id (string)
. ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.
Обязательный параметр
Смещение в списке. Минимальное значение — 0. Значение по умолчанию: 0.
Количество записей (1-100). Значение по умолчанию: 10.
Описание
Код ошибки.
Описание
Сообщение об ошибке.
Описание
Значение.
Описание
Поле.
Описание
ID запрошенного сайта.
Описание
ID сайта.
Описание
Признак подтверждения сайта.
Описание
ID файла Sitemap
.
Описание
Список поддерживаемых типов контента.
Описание
Лимит на количество добавленных сайтов.
Описание
Лимит количества фидов.
Описание
Лимит количества добавленных фидов.
Описание
ID пользователя, от имени которого разрешен доступ.
Описание
Дата и время, до которого адрес доступен для создания задачи.
Описание
Список поддерживаемых типов контента.
Описание
Список поддерживаемых типов кодировки.
Описание
Максимальная длина.
Описание
Минимальная длина.
Описание
Доступное количество запросов в сутки.
Обязательный
Нет
Тип
int32
Описание
Смещение списка. Минимальное значение — 0. Значение по умолчанию: 0.
Обязательный
Нет
Тип
int32
Описание
Количество записей (1—500). Значение по умолчанию: 20.
Обязательный
Нет
Тип
ApiDeviceTypeIndicator
Описание
Тип устройства. Значение по умолчанию: ALL
.
Обязательный
Нет
Тип
Indicator
Описание
Тип данных, по которому отображается статистика. По умолчанию принимает значение QUERY
. Возможные значения:
-
QUERY
— поисковый запрос; -
URL
— адрес страницы сайта.
Обязательный
Да, если передается TextFilters
Тип
Indicator
Описание
Тип данных, по которому отображается статистика. Возможные значения:
-
QUERY
— поисковый запрос; -
URL
— адрес страницы сайта.
Обязательный
Да, если передается TextFilters
Тип
Описание
Операции с URL или текстом запроса.
Обязательный
Да, если передается StatisticFilters
Тип
Описание
Целое число, которое применяется к операции.
Обязательный
Да, если передается SortByDate
Тип
Описание
Тип для описания направления сортировки.
Обязательный
Да, если передается SortByDate
Тип
Описание
Статистические данные, над которыми производится фильтрация.
Обязательный
Да, если передается StatisticFilters
Тип
—
Описание
Начало (включительно) интервала дат в формате yyyy-MM-dd.
Обязательный
Да, если передается SortByDate
Тип
—
Описание
Дата в формате yyyy-MM-dd.
Обязательный
Да, если передается StatisticFilters
Тип
—
Описание
Конец (включительно) интервала дат в формате yyyy-MM-dd.
Обязательный
Да, если передается TextFilters
Тип
string
Описание
Строка, к которой применяется операция. Используется для фильтрации поискового запроса или URL. Например, фрагмент «brand».
Обязательный
Да, если передается StatisticFilters
Тип
string
Описание
Число, с которым нужно сравнить статистическое значение.
Обязательный
Да, если передается StatisticFilters
Тип
Описание
Статистические данные, над которыми производится фильтрация.
Индикаторы типов устройств (ApiDeviceTypeIndicator)
Индикатор |
Описание |
|
Все типы устройств. |
|
Компьютеры. |
|
Мобильные телефоны и планшеты. |
|
Мобильные телефоны. |
|
Планшеты. |
Если в запросе не задан индикатор типа устройства, по умолчанию используется значение ALL
.