Getting the site indexing history

Returns the quantity of indexed site pages, as well as their HTTP status for a specific 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}/indexing/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.

date_from

Start of the date range.

date_to

End of the date range.

Response format

Examples

{
  "indicators": {
    "HTTP_2XX": [
      {
        "date": "2016-01-01T00:00:00,000+0300",
        "value": 1
      }
    ]
  }
}
<Data>     
  <indicators>
    <HTTP_2XX>      
      <date>2016-01-01T00:00:00,000+0300</date>      
      <value>1</value>
    </HTTP_2XX>        
  </indicators>
</Data>

Name

Required

Type

Description

HTTP_2XX

Yes

IndexingStatusEnum

The HTTP status code.

date

Yes

datetime

The date and time the pages were loaded.

value

Yes

int64

Number of pages.

HTTP status codes received by the robot during indexing (IndexingStatusEnum)

Indicator

Description

HTTP_2XX

HTTP_3XX

HTTP_4XX

HTTP_5XX

For more information about statuses, see the help section.

OTHER

Unsupported HTTP code, connection error, or other error.

Response codes

To view the response structure in detail, click the reason.

Code

Reason

Description

200

OK

403

INVALID_USER_ID

The ID of the user who issued the token differs from the one specified in the request. In the examples below, {user_id} shows the correct uid of the OAuth token owner.

{   
    "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

Site management rights are 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

The site isn't indexed yet.

{   
    "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

The site data isn't uploaded to Yandex.Webmaster yet.

{   
    "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>

Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.

Type: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.

Start of the date range.

End of the date range.

Required

Yes

Type

datetime

Description

The date and time the pages were loaded.

Required

Yes

Type

int64

Description

Number of pages.

Description

Error code.

Description

ID of the user who allowed access.

Description

ID of the requested site.

Description

Error message.