Получение информации о популярных запросах

Позволяет получить список топ-500 поисковых запросов, по которым сайт показывался на поиске за последнюю неделю. Можно выбрать 500 запросов с наибольшим числом показов или 500 запросов с наибольшим числом кликов.

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа

Формат запроса

GET https://api.webmaster.yandex.net/v4/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/.

Query-параметры

Имя Обязательный Тип Значение по умолчанию Описание
order_by Да ApiQueryOrderField Показатель для сортировки запросов.
query_indicator Нет ApiQueryIndicator Индикаторы для отображения запросов.

Порядок сортировки запросов (ApiQueryOrderField)

Индикатор Описание
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-01"
}
Имя Обязательный Тип Описание
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 Средняя позиция клика.

Коды ответа

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код Причина Описание
200 OK
403

INVALID_USER_ID

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
HOST_NOT_INDEXED
Файл Sitemap отсутствует.
{
  "error_code": "HOST_NOT_INDEXED", //errorCode. 
  "host_id": "http:ya.ru:80", //id хоста. host id. 
  "error_message": "some string" //Error message. 
}
HOST_NOT_LOADED

Данные о сайте еще не загружены в Яндекс.Вебмастер.

{
  "error_code": "HOST_NOT_LOADED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}