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

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

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/search-queries/popular
  ? order_by=<string>
  & [query_indicator=<string>]
  & [device_type_indicator=<string>]
  & [date_from=<datetime>]
  & [date_to=<datetime>]
  & [offset=<int32>]
  & [limit=<int32>]

user-id

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

host-id

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

order_by*

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

query_indicator

Индикаторы для отображения запросов (ApiQueryIndicator).

device_type_indicator

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

date_from

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

date_to

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

offset

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

limit

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

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

Индикатор

Описание

TOTAL_SHOWS

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

TOTAL_CLICKS

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

Индикатор

Описание

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": 1.1, ...
      }
    }, ...
  ],
  "date_from": "2016-01-01",
  "date_to": "2016-01-07",
  "count": "300"
}

<Data>
    <query>
        <query_id>a08b</query_id>
        <query_text>some text</query_text>
        <indicators>
            <TOTAL_SHOWS>1.1</TOTAL_SHOWS>
            ...
        </indicators>
    </query>
    ...
    <date_from>2016-01-01</date_from>
    <date_to>2016-01-07</date_to>
    <count>300</count>
</Data>

Имя

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

Тип

Описание

Примечание

query_id

Да

string

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

—

query_text

Да

string

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

—

TOTAL_SHOWS

Да

ApiQueryIndicator

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

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

date_from

Да

datetime

Дата начала интервала.

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

date_to

Да

datetime

Дата конца интервала.

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

count

Да

int32

Общее количество доступных поисковых запросов.

—

Индикатор

Описание

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>

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

Предыдущая
Получение истории изменения ИКС
Следующая
Получение статистики по всем запросам