Getting the history of SQI changes

Returns the history of changes in the site quality index (SQI) over the past year.

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/sqi-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

Example

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

Name

Type

Description

date

timedate

Date and time of the SQI update.

value

int64

The site quality index value.

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_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>

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>

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.

Type

timedate

Description

Date and time of the SQI update.

Type

int64

Description

The site quality index value.

Description

Error code.

Description

ID of the user who allowed access.

Description

ID of the requested site.

Description

Error message.