Получение общей статистики по поисковому запросу

Позволяет получить историю изменения показателей по определенному поисковому запросу за указанный период времени.

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

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/search-queries/{query-id}/history
 ? [query_indicator=<string>]
 & [device_type_indicator=<string>]
 & [date_from=<datetime>]
 & [date_to=<datetime>]
user-id Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
host-idТип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts.
query-idТип: string. ID поискового запроса. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts/{host-id}/search-queries/popular.
user-id Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
host-idТип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts.
query-idТип: string. ID поискового запроса. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts/{host-id}/search-queries/popular.
query_indicatorИндикаторы для отображения запросов (ApiQueryIndicator). Можно указать несколько индикаторов. Например, query_indicator=TOTAL_SHOWS&query_indicator=TOTAL_CLICKS.
device_type_indicator

Тип устройства (ApiDeviceTypeIndicator). Значение по умолчанию: ALL.

date_from

Дата начала интервала. Если не указан, то данные возвращаются за последнюю неделю.

date_to

Дата конца интервала. Если не указан, то данные возвращаются за последнюю неделю.

query_indicatorИндикаторы для отображения запросов (ApiQueryIndicator). Можно указать несколько индикаторов. Например, query_indicator=TOTAL_SHOWS&query_indicator=TOTAL_CLICKS.
device_type_indicator

Тип устройства (ApiDeviceTypeIndicator). Значение по умолчанию: ALL.

date_from

Дата начала интервала. Если не указан, то данные возвращаются за последнюю неделю.

date_to

Дата конца интервала. Если не указан, то данные возвращаются за последнюю неделю.

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

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

Индикаторы типов устройств (ApiDeviceTypeIndicator)

Индикатор Описание
ALL Все типы устройств.
DESKTOP Компьютеры.
MOBILE_AND_TABLET Мобильные телефоны и планшеты.
MOBILE Мобильные телефоны.
TABLET Планшеты.
Индикатор Описание
ALL Все типы устройств.
DESKTOP Компьютеры.
MOBILE_AND_TABLET Мобильные телефоны и планшеты.
MOBILE Мобильные телефоны.
TABLET Планшеты.

Если в запросе не задан индикатор типа устройства, по умолчанию используется значение ALL.

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

Примеры

{
  "queries": [
    {
      "query_id": "a08b",
      "query_text": "some text",
      "indicators": {
        "TOTAL_SHOWS": [
            {
                "date": "2019-07-18T00:00:00.000+03:00",
                "value": 2.0
            },
            ...
        ]
    }
}               
Имя Обязательный Тип Описание Примечание
query_id Да string ID поискового запроса.
query_text Да string Текст поискового запроса.
TOTAL_SHOWS Да ApiQueryIndicator Показатель поискового запроса. Может отсутствовать, если его значение не определено.
Имя Обязательный Тип Описание Примечание
query_id Да string ID поискового запроса.
query_text Да string Текст поискового запроса.
TOTAL_SHOWS Да ApiQueryIndicator Показатель поискового запроса. Может отсутствовать, если его значение не определено.

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

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

Коды ответа

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

Код Причина Описание
200 OK
404 QUERY_ID_NOT_FOUND
Указан несуществующий ID поискового запроса.
{
  "error_code": "QUERY_ID_NOT_FOUND",
  "error_message": "some string"
}
Код Причина Описание
200 OK
404 QUERY_ID_NOT_FOUND
Указан несуществующий ID поискового запроса.
{
  "error_code": "QUERY_ID_NOT_FOUND",
  "error_message": "some string"
}