Getting the history of pages added to and removed from search results
Returns the number of pages that appeared in search and were removed from search results in a given period. By default, data for the current day is returned.
Request format
GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/search-urls/events/history
? [date_from=<datetime>]
& [date_to=<datetime>]
user-id | Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method. |
host-id | Type: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method. |
user-id | Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method. |
host-id | Type: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method. |
date_from | Start of the date range. |
date_to | End of the date range. |
date_from | Start of the date range. |
date_to | End of the date range. |
Response format
Examples
{
"indicators": {
"APPEARED_IN_SEARCH": [
{
"date": "2016-01-01T00:00:00,000+0300",
"value": 1
}
]
}
}
<Data>
<indicators>
<APPEARED_IN_SEARCH>
<date>2016-01-01T00:00:00,000+0300</date>
<value>1</value>
</APPEARED_IN_SEARCH>
</indicators>
</Data>
Name | Required | Type | Description |
---|---|---|---|
APPEARED_IN_SEARCH | Yes | The page status (ApiSearchEventEnum). | |
date | Yes | datetime | Date and time when the search output was updated. |
value | Yes | int64 | Number of pages. |
Name | Required | Type | Description |
---|---|---|---|
APPEARED_IN_SEARCH | Yes | The page status (ApiSearchEventEnum). | |
date | Yes | datetime | Date and time when the search output was updated. |
value | Yes | int64 | Number of pages. |
Site page status in search results (ApiSearchEventEnum)
Indicator | Description |
---|---|
APPEARED_IN_SEARCH | The page appeared in search results. |
REMOVED_FROM_SEARCH | The page was removed from search results. |
Indicator | Description |
---|---|
APPEARED_IN_SEARCH | The page appeared in search results. |
REMOVED_FROM_SEARCH | The page was removed from search results. |
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 site isn't indexed yet. | |
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 site isn't indexed yet. | |
HOST_NOT_LOADED | The site data isn't uploaded to Yandex.Webmaster yet. |