---
metadata:
  - name: generator
    content: Diplodoc Platform v5.44.0
alternate:
  - https://yandex.com/dev/webmaster/doc/en/reference/host-search-queries-history.md
  - https://yandex.com/dev/webmaster/doc/ru/reference/host-search-queries-history.md
keywords:
  - с
  - а
  - й
  - т
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/webmaster/doc/ru/llms.txt


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

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

## Формат запроса {#request-format}

```
GET https://api.webmaster.yandex.net/v4/user/{[user-id](*user-id)}/hosts/{[host-id](*host-id)}/search-queries/{[query-id](*query-id)}/history
  ? [[query_indicator](*query_indicator)=<string>]
  & [[device_type_indicator](*device_type_indicator)=<string>]
  & [[date_from](*date_from)=<datetime>]
  & [[date_to](*date_to)=<datetime>]
```



#|
||
`user-id`
|
    
<!-- source: ru/_includes/popup/user-id.md -->
Тип: `int64`. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод [GET /v4/user](https://yandex.com/dev/webmaster/doc/ru/reference/user.md).
<!-- endsource: ru/_includes/popup/user-id.md -->
    
||
||
`host-id`
|
    
<!-- source: ru/_includes/popup/host-id.md -->
Тип: `string`. ID сайта. Чтобы получить его, используйте метод [GET&nbsp;/v4/user/{user&#x2011;id}/hosts](https://yandex.com/dev/webmaster/doc/ru/reference/hosts.md).
<!-- endsource: ru/_includes/popup/host-id.md -->

||
||
`query-id`
|
<!-- source: ru/_includes/reference/host-search-queries-history/query-id.md -->
Тип: `string`. ID поискового запроса. Чтобы получить его, используйте метод [GET /v4/user/{user-id}/hosts/{host-id}/search-queries/popular](https://yandex.com/dev/webmaster/doc/ru/reference/host-search-queries-popular.md).
<!-- endsource: ru/_includes/reference/host-search-queries-history/query-id.md -->
||
||
`query_indicator`
|
<!-- source: ru/_includes/reference/host-search-queries-history/query_indicator.md -->
Индикаторы для отображения запросов ([ApiQueryIndicator](*query-indicators)). Можно указать несколько индикаторов. Например, `query_indicator=TOTAL_SHOWS&query_indicator=TOTAL_CLICKS`.
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_indicator.md -->
||
||
`device_type_indicator`
|

<!-- source: ru/_includes/reference/host-search-queries-history/device_type_indicator.md -->
Тип устройства ([ApiDeviceTypeIndicator](*device-type-ind)). Значение по умолчанию: `ALL`.
<!-- endsource: ru/_includes/reference/host-search-queries-history/device_type_indicator.md -->


||
||
`date_from`
|

<!-- source: ru/_includes/popup/date_from2.md -->
Дата начала интервала. Если не указан, то данные возвращаются за последнюю неделю.
<!-- endsource: ru/_includes/popup/date_from2.md -->
||
||
`date_to`
|

<!-- source: ru/_includes/popup/date_to2.md -->
Дата конца интервала. Если не указан, то данные возвращаются за последнюю неделю.
<!-- endsource: ru/_includes/popup/date_to2.md -->

||
|#

<!-- source: ru/_includes/reference/errors/query-indicators.md -->
### Индикаторы запросов (ApiQueryIndicator) {#query-indicators}

#|
||
**Индикатор**
|
**Описание**
||
||
`TOTAL_SHOWS`
|
Количество показов.
||
||
`TOTAL_CLICKS`
|
Количество кликов.
||
||
`AVG_SHOW_POSITION`
|
Средняя позиция показа.
||
||
`AVG_CLICK_POSITION`
|
Средняя позиция клика.
||
|#
<!-- endsource: ru/_includes/reference/errors/query-indicators.md -->

<!-- source: ru/_includes/reference/errors/device-type.md -->
### Индикаторы типов устройств (ApiDeviceTypeIndicator) {#device-type}

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


Если в запросе не задан индикатор типа устройства, по умолчанию используется значение `ALL`.
<!-- endsource: ru/_includes/reference/errors/device-type.md -->


## Формат ответа {#response-format}

### Примеры
> 
> 
> {% list tabs %}
> 
> - JSON
> 
>   
>   ```javascript
>   {
>     "queries": [
>       {
>         "query_id": "a08b",
>         "query_text": "some text",
>         "indicators": {
>           "TOTAL_SHOWS": [
>               {
>                   "date": "2019-07-18T00:00:00.000+03:00",
>                   "value": 2.0
>               },
>               ...
>           ]
>       }
>   }               
>   ```
>   
> 
> - XML
> 
>   
>   ```xml
>   <Data>
>       <query>
>           <[query_id](*query_id)>a08b</query_id>
>           <[query_text](*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>
>   ```
> 
> {% endlist %}

#|
||
**Имя**
|
**Обязательный**
|
**Тип**
|
**Описание**
|
**Примечание**
||
||
`query_id`
|
<!-- source: ru/_includes/reference/host-search-queries-history/query_id/req.md -->
Да
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_id/req.md -->
|
<!-- source: ru/_includes/reference/host-search-queries-history/query_id/type.md -->
`string`
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_id/type.md -->
|
<!-- source: ru/_includes/reference/host-search-queries-history/query_id/desc.md -->
ID поискового запроса.
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_id/desc.md -->
|
<!-- source: ru/_includes/reference/host-search-queries-history/query_id/note.md -->
—
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_id/note.md -->
||
||
`query_text`
|
<!-- source: ru/_includes/reference/host-search-queries-history/query_text/req.md -->
Да
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_text/req.md -->
|
<!-- source: ru/_includes/reference/host-search-queries-history/query_text/type.md -->
`string`
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_text/type.md -->
|
<!-- source: ru/_includes/reference/host-search-queries-history/query_text/desc.md -->
Текст поискового запроса.
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_text/desc.md -->
|
<!-- source: ru/_includes/reference/host-search-queries-history/query_text/note.md -->
—
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_text/note.md -->
||
||
[TOTAL_SHOWS](*query-indicators)
|
Да
|
[ApiQueryIndicator](*query-indicators)
|
Показатель поискового запроса.
|
Может отсутствовать, если его значение не определено.
||
|#

<!-- source: ru/_includes/reference/errors/query-indicators.md -->
### Индикаторы запросов (ApiQueryIndicator) {#query-indicators}

#|
||
**Индикатор**
|
**Описание**
||
||
`TOTAL_SHOWS`
|
Количество показов.
||
||
`TOTAL_CLICKS`
|
Количество кликов.
||
||
`AVG_SHOW_POSITION`
|
Средняя позиция показа.
||
||
`AVG_CLICK_POSITION`
|
Средняя позиция клика.
||
|#
<!-- endsource: ru/_includes/reference/errors/query-indicators.md -->


## Коды ответа {#errors}


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

#|

||
**Код**
|
**Причина**
|
**Описание**
||


||
200
|
OK
|
||

||
404
|
[QUERY_ID_NOT_FOUND](https://yandex.com/dev/webmaster/doc/ru/reference/errors.md#query-id-not-found)
|
Указан несуществующий ID поискового запроса.

<!-- source: ru/_includes/reference/errors/dl-query-id-not-found.md -->
{% list tabs %}

- JSON

  
  ```javascript
  {
    "error_code": "QUERY_ID_NOT_FOUND",
    "error_message": "some string"
  }
  ```
  

- XML

  
  ```xml
  <Data>
    <[error_code](*error_code)>QUERY_ID_NOT_FOUND</error_code>  
    <[error_message](*error_message)>some string</error_message>
  </Data>
  ```

{% endlist %}
<!-- endsource: ru/_includes/reference/errors/dl-query-id-not-found.md -->

||
|#

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

- [Коды ошибок и статусы](https://yandex.com/dev/webmaster/doc/ru/reference/errors.md)






[*user-id]: Тип: `int64`. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод [GET /v4/user](https://yandex.com/dev/webmaster/doc/ru/reference/user.md).

[*host-id]: Тип: `string`. ID сайта. Чтобы получить его, используйте метод [GET&nbsp;/v4/user/{user&#x2011;id}/hosts](https://yandex.com/dev/webmaster/doc/ru/reference/hosts.md).

[*query-id]: Тип: `string`. ID поискового запроса. Чтобы получить его, используйте метод [GET /v4/user/{user-id}/hosts/{host-id}/search-queries/popular](https://yandex.com/dev/webmaster/doc/ru/reference/host-search-queries-popular.md).

[*query_indicator]: Индикаторы для отображения запросов ([ApiQueryIndicator](https://yandex.com/dev/webmaster/doc/ru/reference/host-search-queries-popular.md#query-indicators)). Можно указать несколько индикаторов. Например, `query_indicator=TOTAL_SHOWS&query_indicator=TOTAL_CLICKS`.

[*device_type_indicator]: Тип устройства ([ApiDeviceTypeIndicator](#device-type)). Значение по умолчанию: `ALL`.

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

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

[*query_id]: **Обязательный**

<!-- source: ru/_includes/reference/host-search-queries-history/query_id/req.md -->
Да
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_id/req.md -->

**Тип**

<!-- source: ru/_includes/reference/host-search-queries-history/query_id/type.md -->
`string`
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_id/type.md -->

**Описание**

<!-- source: ru/_includes/reference/host-search-queries-history/query_id/desc.md -->
ID поискового запроса.
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_id/desc.md -->

**Примечание**

<!-- source: ru/_includes/reference/host-search-queries-history/query_id/note.md -->
—
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_id/note.md -->

[*query_text]: **Обязательный**

<!-- source: ru/_includes/reference/host-search-queries-history/query_text/req.md -->
Да
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_text/req.md -->

**Тип**

<!-- source: ru/_includes/reference/host-search-queries-history/query_text/type.md -->
`string`
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_text/type.md -->

**Описание**

<!-- source: ru/_includes/reference/host-search-queries-history/query_text/desc.md -->
Текст поискового запроса.
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_text/desc.md -->

**Примечание**

<!-- source: ru/_includes/reference/host-search-queries-history/query_text/note.md -->
—
<!-- endsource: ru/_includes/reference/host-search-queries-history/query_text/note.md -->

[*query-indicators]: 
### Индикаторы запросов (ApiQueryIndicator) {#query-indicators}

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