Diagnostics

Returns information about the Turbo page errors.

To access the resource, you need a token for retrieving indexing status information.

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/diagnostics
user-idUser ID. To get the value, use the GET /v4/user operation.
host-id
Site ID. Has the scheme:host:port format, where
  • scheme — The http or https protocol.
  • host — Site URL with or without www.
  • port — The port to connect to. For the http protocol — 80, for the https protocol — 443.

For example: https:example.com:443 or http:www.example.com:80.

You can also get the site ID using the operation GET /user/{user-id}/hosts.

user-idUser ID. To get the value, use the GET /v4/user operation.
host-id
Site ID. Has the scheme:host:port format, where
  • scheme — The http or https protocol.
  • host — Site URL with or without www.
  • port — The port to connect to. For the http protocol — 80, for the https protocol — 443.

For example: https:example.com:443 or http:www.example.com:80.

You can also get the site ID using the operation GET /user/{user-id}/hosts.

Response format

The service returns data in either JSON (default) or XML format. To get the XML response, pass the HTTP header Accept: application/xml in the request.

{
  "problems": {
    "NO_SITEMAPS": {
      "severity": "FATAL",
      "state": "PRESENT",
      "last_state_update": "2016-01-01T00:00:00,000+0300"
    }
  }
}
NO_SITEMAPS
Problem. Possible values:
  • TURBO_FEED_ERROR — Errors found when processing the RSS feed for Turbo pages.
  • TURBO_FEED_WARNING — Warnings found when processing the RSS feed for Turbo pages.
  • TURBO_FEED_BAN — Some RSS feeds were rejected.
  • TURBO_DOCUMENT_BAN — The display of some Turbo pages on the site is disabled.
  • TURBO_HOST_BAN — Display of Turbo pages is turned off.
  • TURBO_INSUFFICIENT_CLICKS_SHARE — Turbo pages cover too little search traffic.
severity
Issue type Possible values:
  • FATAL — Fatal issue. The service checks if the RSS feed content matches the content of the site pages. May lead to the ban on displaying Turbo pages. We recommend monitoring these errors and fixing them as soon as possible.
  • CRITICAL — Critical issue. Related to updating the RSS feed. May lead to the ban on displaying Turbo pages. We recommend monitoring these errors and fixing them as soon as possible.
  • POSSIBLE_PROBLEM — Warning. The service examines the content of the item element. For the item elements with errors, Turbo pages aren't generated.
state
State of the issue. Possible values:
  • PRESETS — Present on the site.
  • ABSENT — Absent.
  • UNDEFINED — Not enough data to determine if there are issues.
last_state_update
The date the issue status was last changed.

To learn more about the status, go to the Turbo pages for content sites → Diagnostics page in Yandex.Webmaster. You can also configure notifications to receive the diagnostic messages by email.

Response codes

Code Description
200 OK The request is successfully completed.
403 Forbidden
INVALID_USER_ID
The ID of the user who issued the token differs from the one specified in the request. The examples below {user_id} show the correct uid of the OAuth token owner.
Example response
{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Copied to clipboard
error_code
Error code.
available_user_id
ID of the user who allowed access.
error_message
Error message.
404 Not Found
HOST_NOT_VERIFIED
Site management rights are not verified.
Example response
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
Copied to clipboard
error_code
Error code.
host_id
ID of the requested site.
error_message
Error message.
Code Description
200 OK The request is successfully completed.
403 Forbidden
INVALID_USER_ID
The ID of the user who issued the token differs from the one specified in the request. The examples below {user_id} show the correct uid of the OAuth token owner.
Example response
{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Copied to clipboard
error_code
Error code.
available_user_id
ID of the user who allowed access.
error_message
Error message.
404 Not Found
HOST_NOT_VERIFIED
Site management rights are not verified.
Example response
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
Copied to clipboard
error_code
Error code.
host_id
ID of the requested site.
error_message
Error message.