Getting information about popular queries
Gets a list of the top 500 search queries the site was shown for in the search results over the past week. You can choose 500 queries with the most displays or 500 queries with the most clicks.
Request format
GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/search-queries/popular/?order_by={order_by}[&query_indicator={query_indicator}]
Path parameters
Name | Required | Type | Default value | Description |
---|---|---|---|---|
user-id | Yes | int64 | User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /user method. | |
host-id | Yes | host id | The site ID. To get it, use the GET /user/{user-id}/hosts method. |
Name | Required | Type | Default value | Description |
---|---|---|---|---|
user-id | Yes | int64 | User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /user method. | |
host-id | Yes | host id | The site ID. To get it, use the GET /user/{user-id}/hosts method. |
Query parameters
Name | Required | Type | Default value | Description |
---|---|---|---|---|
order_by | Yes | ApiQueryOrderField | Indicator for sorting queries. | |
query_indicator | No | ApiQueryIndicator | Indicators for displaying queries. |
Name | Required | Type | Default value | Description |
---|---|---|---|---|
order_by | Yes | ApiQueryOrderField | Indicator for sorting queries. | |
query_indicator | No | ApiQueryIndicator | Indicators for displaying queries. |
Query sorting order (ApiQueryOrderField)
Indicator | Description |
---|---|
TOTAL_SHOWS | The number of displays. |
TOTAL_CLICKS | The number of clicks. |
Indicator | Description |
---|---|
TOTAL_SHOWS | The number of displays. |
TOTAL_CLICKS | The number of clicks. |
Response format
Examples
{
"queries": [
{
"query_id": "a08b",
"query_text": "some text",
"indicators": {
"TOTAL_SHOWS": 1.1, ...
}
}, ...
],
"date_from": "2016-01-01",
"date_to": "2016-01-07"
}
<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>
</Data>
Name | Required | Type | Description |
---|---|---|---|
query_id | Yes | int64 | The request ID. |
query_text | Yes | string | Query text. |
TOTAL_SHOWS | Yes | ApiQueryIndicator | The query indicator (can be omitted if its value is not defined). |
date_from | Yes | datetime | The start date of the range. |
date_to | Yes | datetime | The end date of the range. |
Name | Required | Type | Description |
---|---|---|---|
query_id | Yes | int64 | The request ID. |
query_text | Yes | string | Query text. |
TOTAL_SHOWS | Yes | ApiQueryIndicator | The query indicator (can be omitted if its value is not defined). |
date_from | Yes | datetime | The start date of the range. |
date_to | Yes | datetime | The end date of the range. |
Query indicators (ApiQueryIndicator)
Indicator | Description |
---|---|
TOTAL_SHOWS | The number of displays. |
TOTAL_CLICKS | The number of clicks. |
AVG_SHOW_POSITION | The average position of the display. |
AVG_CLICK_POSITION | Average click position. |
Indicator | Description |
---|---|
TOTAL_SHOWS | The number of displays. |
TOTAL_CLICKS | The number of clicks. |
AVG_SHOW_POSITION | The average position of the display. |
AVG_CLICK_POSITION | Average click position. |
Response codes
To view the response structure in detail, click the reason.
Code | Reason | Description |
---|---|---|
200 | OK | |
403 | The ID of the user who issued the token differs from the one specified in the request. In the examples below, | |
404 | HOST_NOT_VERIFIED | Site management rights are not verified. |
HOST_NOT_INDEXED | The Sitemap file is missing. | |
HOST_NOT_LOADED | The site data isn't uploaded to Yandex.Webmaster yet. |
Code | Reason | Description |
---|---|---|
200 | OK | |
403 | The ID of the user who issued the token differs from the one specified in the request. In the examples below, | |
404 | HOST_NOT_VERIFIED | Site management rights are not verified. |
HOST_NOT_INDEXED | The Sitemap file is missing. | |
HOST_NOT_LOADED | The site data isn't uploaded to Yandex.Webmaster yet. |