Получение информации о популярных запросах
Внимание. Вы открыли документацию API версии 3.2. Яндекс Вебмастер перестал поддерживать версию 3.2 и ниже со второго полугодия 2020 г. Рекомендуем использовать API версии 4.1.
Позволяет получить список ТОП-500 поисковых запросов, по которым сайт показывался на поиске за последнюю неделю. Можно выбрать 500 запросов с наибольшим числом показов или 500 запросов с наибольшим числом кликов.
Формат запроса
GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/search-queries/popular/?order_by={order_by}[&query_indicator={query_indicator}]
Path-параметры
Имя | Обязательный | Тип | Значение по умолчанию | Описание |
---|---|---|---|---|
user-id | Да | int64 | ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /user. | |
host-id | Да | host id | ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts. |
Имя | Обязательный | Тип | Значение по умолчанию | Описание |
---|---|---|---|---|
user-id | Да | int64 | ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /user. | |
host-id | Да | host id | ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts. |
Query-параметры
Имя | Обязательный | Тип | Значение по умолчанию | Описание |
---|---|---|---|---|
order_by | Да | ApiQueryOrderField | Показатель для сортировки запросов. | |
query_indicator | Нет | ApiQueryIndicator | Индикаторы для отображения запросов. |
Имя | Обязательный | Тип | Значение по умолчанию | Описание |
---|---|---|---|---|
order_by | Да | ApiQueryOrderField | Показатель для сортировки запросов. | |
query_indicator | Нет | ApiQueryIndicator | Индикаторы для отображения запросов. |
Порядок сортировки запросов (ApiQueryOrderField)
Индикатор | Описание |
---|---|
TOTAL_SHOWS | Количество показов. |
TOTAL_CLICKS | Количество кликов. |
Индикатор | Описание |
---|---|
TOTAL_SHOWS | Количество показов. |
TOTAL_CLICKS | Количество кликов. |
Формат ответа
Примеры
{
"queries": [
{
"query_id": "a08b",
"query_text": "some text",
"indicators": {
"TOTAL_SHOWS": 1.1, ...
}
}, ...
],
"date_from": "2016-01-01",
"date_to": "2016-01-07"
}
<Data>
<query>
<query_id>a08b</query_id>
<query_text>some text</query_text>
<indicators>
<TOTAL_SHOWS>1.1</TOTAL_SHOWS>
...
</indicators>
</query>
...
<date_from>2016-01-01</date_from>
<date_to>2016-01-07</date_to>
</Data>
Имя | Обязательный | Тип | Описание |
---|---|---|---|
query_id | Да | int64 | ID запроса. |
query_text | Да | string | Текст запроса. |
TOTAL_SHOWS | Да | ApiQueryIndicator | Показатель запроса (может отсутствовать, если его значение не определено). |
date_from | Да | datetime | Дата начала интервала. |
date_to | Да | datetime | Дата конца интервала. |
Имя | Обязательный | Тип | Описание |
---|---|---|---|
query_id | Да | int64 | ID запроса. |
query_text | Да | string | Текст запроса. |
TOTAL_SHOWS | Да | ApiQueryIndicator | Показатель запроса (может отсутствовать, если его значение не определено). |
date_from | Да | datetime | Дата начала интервала. |
date_to | Да | datetime | Дата конца интервала. |
Индикаторы запросов (ApiQueryIndicator)
Индикатор | Описание |
---|---|
TOTAL_SHOWS | Количество показов. |
TOTAL_CLICKS | Количество кликов. |
AVG_SHOW_POSITION | Средняя позиция показа. |
AVG_CLICK_POSITION | Средняя позиция клика. |
Индикатор | Описание |
---|---|
TOTAL_SHOWS | Количество показов. |
TOTAL_CLICKS | Количество кликов. |
AVG_SHOW_POSITION | Средняя позиция показа. |
AVG_CLICK_POSITION | Средняя позиция клика. |
Коды ответа
Чтобы посмотреть структуру ответа подробнее, нажмите на причину.
Код | Причина | Описание |
---|---|---|
200 | OK | |
403 | ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже | |
404 | HOST_NOT_VERIFIED | Не подтверждены права на управление сайтом. |
HOST_NOT_INDEXED | Файл Sitemap отсутствует. | |
HOST_NOT_LOADED | Данные о сайте еще не загружены в Яндекс Вебмастер. |
Код | Причина | Описание |
---|---|---|
200 | OK | |
403 | ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже | |
404 | HOST_NOT_VERIFIED | Не подтверждены права на управление сайтом. |
HOST_NOT_INDEXED | Файл Sitemap отсутствует. | |
HOST_NOT_LOADED | Данные о сайте еще не загружены в Яндекс Вебмастер. |