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

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

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

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.

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.

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

Примеры

{
  "queries": [
    {
      "query_id": "a08b",
      "query_text": "some text",
      "indicators": {
        "TOTAL_SHOWS": [
            {
                "date": "2019-07-18T00:00:00.000+03:00",
                "value": 2.0
            },
            ...
        ]
    }
}               
<Data>
    <query>
        <query_id>a08b</query_id>
        <query_text>some text</query_text>
        <indicators>
            <TOTAL_SHOWS>
                <date>2019-07-18T00:00:00.000+03:00</date>
                <value>2.0</value>
                ...
            </TOTAL_SHOWS>
            ...
        </indicators>
    </query>
</Data>

Имя

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

Тип

Описание

Примечание

query_id

Да

string

ID поискового запроса.

query_text

Да

string

Текст поискового запроса.

TOTAL_SHOWS

Да

ApiQueryIndicator

Показатель поискового запроса.

Может отсутствовать, если его значение не определено.

Индикатор

Описание

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"
}
<Data>
  <error_code>QUERY_ID_NOT_FOUND</error_code>  
  <error_message>some string</error_message>
</Data>

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

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

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

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

Смещение в списке. Минимальное значение — 0. Значение по умолчанию: 0.

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

Описание

Код ошибки.

Описание

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

Описание

Значение.

Описание

Поле.

Описание

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

Описание

ID сайта.

Описание

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

Описание

ID файла Sitemap.

Описание

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

Описание

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

Описание

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

Описание

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

Описание

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

Описание

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

Описание

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

Описание

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

Описание

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

Описание

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

Описание

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

Тип: string. ID поискового запроса. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts/{host-id}/search-queries/popular.

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

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

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

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

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

Да

Тип

string

Описание

ID поискового запроса.

Примечание

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

Да

Тип

string

Описание

Текст поискового запроса.

Примечание

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

Индикатор

Описание

TOTAL_SHOWS

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

TOTAL_CLICKS

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

AVG_SHOW_POSITION

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

AVG_CLICK_POSITION

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

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

Индикатор

Описание

ALL

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

DESKTOP

Компьютеры.

MOBILE_AND_TABLET

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

MOBILE

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

TABLET

Планшеты.

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