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

Описание

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

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

Отправьте GET-запрос на адрес операции search-queries/popular ресурса сайта пользователя.

GET https://api.webmaster.yandex.net/v3/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 Количество кликов.

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

В случае успеха сервер возвращает 200 OK и список популярных поисковых запросов:

Примеры

{
  "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 Да yyyy-MM-ddTHH:mm:ss,sssZ Дата начала интервала.
date_to Да yyyy-MM-ddTHH:mm:ss,sssZ Дата конца интервала.

Индикаторы запросов (ApiQueryIndicator)

Индикатор Описание
TOTAL_SHOWS Количество показов.
TOTAL_CLICKS Количество кликов.
AVG_SHOW_POSITION Средняя позиция показа.
AVG_CLICK_POSITION Средняя позиция клика.

Ошибки

403 Forbidden

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

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Параметр Описание
error_code Код ошибки.
available_user_id ID пользователя, от имени которого разрешен доступ.
error_message Сообщение об ошибке.

404 Not Found

  • Код ошибки HOST_NOT_INDEXED

    {
      "error_code": "HOST_NOT_INDEXED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    Параметр Описание
    error_code Сайт еще не проиндексирован.
    host_id ID запрошенного сайта.
    error_message Сообщение об ошибке.
  • Код ошибки HOST_NOT_LOADED

    {
      "error_code": "HOST_NOT_LOADED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    Параметр Описание
    error_code Данные о сайте еще не загружены в Яндекс.Вебмастер.
    host_id ID запрошенного сайта.
    error_message Сообщение об ошибке.
  • Код ошибки HOST_NOT_VERIFIED

    {
      "error_code": "HOST_NOT_VERIFIED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    Параметр Описание
    error_code Сайт не добавлен в список сайтов или права не подтверждены пользователем.
    host_id ID запрошенного сайта.
    error_message Сообщение об ошибке.