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

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

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/search-queries/all/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_indicator

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

query_indicator=
TOTAL_SHOWS&query_indicator=TOTAL_CLICKS

device_type_indicator

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

date_from

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

date_to

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

Индикатор

Описание

TOTAL_SHOWS

Количество показов.

TOTAL_CLICKS

Количество кликов.

AVG_SHOW_POSITION

Средняя позиция показа.

AVG_CLICK_POSITION

Средняя позиция клика.

Индикатор

Описание

ALL

Все типы устройств.

DESKTOP

Компьютеры.

MOBILE_AND_TABLET

Мобильные телефоны и планшеты.

MOBILE

Мобильные телефоны.

TABLET

Планшеты.

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

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

Примеры

{
    "indicators": {
        "TOTAL_SHOWS": [
            {
                "date": "2019-07-18T00:00:00.000+03:00",
                "value": 100.0
            },
            ...
            }
        ]
    }
}
<Data>
    <query>
        <indicators>
            <TOTAL_SHOWS>
                <date>2019-07-18T00:00:00.000+03:00</date>
                <value>100.0</value>
                ...
            </TOTAL_SHOWS>
        </indicators>
    </query>
</Data>

Имя

Обязательный

Тип

Описание

Примечание

TOTAL_SHOWS

Да

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."
}
<Data>
    <error_code>INVALID_USER_ID</error_code>
    <available_user_id>1</available_user_id>
    <error_message>Invalid user id. {user_id} should be used.</error_message>
</Data>

404

HOST_NOT_VERIFIED

Не подтверждены права на управление сайтом.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
<Data>
  <error_code>HOST_NOT_VERIFIED</error_code>  
  <host_id>http:ya.ru:80</host_id>
  <error_message>some string</error_message>
</Data>

404

HOST_NOT_INDEXED

Сайт не проиндексирован.

{
  "error_code": "HOST_NOT_INDEXED", //errorCode. 
  "host_id": "http:ya.ru:80", //id хоста. host id. 
  "error_message": "some string" //Error message. 
}
<Data>
  <error_code>HOST_NOT_INDEXED</error_code>  
  <host_id>http:ya.ru:80</host_id>  
  <error_message>some string</error_message>
</Data>

404

HOST_NOT_LOADED

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

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

Узнайте больше

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

Тип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

Количество записей (1-100). Значение по умолчанию: 10.

Описание

Код ошибки.

Описание

Сообщение об ошибке.

Описание

Значение.

Описание

Поле.

Описание

ID запрошенного сайта.

Описание

ID сайта.

Описание

Признак подтверждения сайта.

Описание

ID файла Sitemap.

Описание

Список поддерживаемых типов контента.

Описание

Лимит на количество добавленных сайтов.

Описание

Лимит количества фидов.

Описание

Лимит количества добавленных фидов.

Описание

ID пользователя, от имени которого разрешен доступ.

Описание

Дата и время, до которого адрес доступен для создания задачи.

Описание

Список поддерживаемых типов контента.

Описание

Список поддерживаемых типов кодировки.

Описание

Максимальная длина.

Описание

Минимальная длина.

Описание

Доступное количество запросов в сутки.

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

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

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

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

query_indicator=
TOTAL_SHOWS&query_indicator=TOTAL_CLICKS

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

Индикатор

Описание

TOTAL_SHOWS

Количество показов.

TOTAL_CLICKS

Количество кликов.

AVG_SHOW_POSITION

Средняя позиция показа.

AVG_CLICK_POSITION

Средняя позиция клика.

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

Индикатор

Описание

ALL

Все типы устройств.

DESKTOP

Компьютеры.

MOBILE_AND_TABLET

Мобильные телефоны и планшеты.

MOBILE

Мобильные телефоны.

TABLET

Планшеты.

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