Getting site statistics

Description

Gets general information about a site.

Request format

Send a GET request to the address of the summary resource for the user's site:

GET https://api.webmaster.yandex.net/v3/user/{user-id}/hosts/{host-id}/summary/

Path parameters

Name Required Type Default value Description
user-id Yes int64 The user ID.
host-id Yes host id Site ID.

Response format

If successful, the server returns 200 and the requested site statistics.

Example

Parameter Description
tic The TIC of the site.
downloaded_pages_count The number of pages loaded by the Yandex robot.
excluded_pages_count The number of excluded pages.
searchable_pages_count The number of pages in search.
site_problems The number of problems found on the site, grouped by severity (see Error severity).

Error severity (SiteProblemSeverityEnum)

Code Description
FATAL Fatal errors.
CRITICAL Critical problems.
POSSIBLE_PROBLEM Possible issues.
RECOMMENDATION Recommendations.

Errors

403 Forbidden

The user ID for the token doesn't match the one specified in the request. In the examples below, {user_id} is the correct uid for the owner of the OAuth token.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Parameter Description
error_code Error code.
available_user_id ID of the user who allowed access.
error_message Error message.

404 Not Found

  • HOST_NOT_INDEXED error

    The site hasn't been indexed yet.

    {
      "error_code": "HOST_NOT_INDEXED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    Parameter Description
    error_code Error code.
    host_id Site ID.
    error_message Error message.
  • HOST_NOT_LOADED error

    The site data hasn't been loaded to Yandex.Webmaster yet.

    {
      "error_code": "HOST_NOT_LOADED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    Parameter Description
    error_code Error code.
    host_id Site ID.
    error_message Error message.
  • HOST_NOT_VERIFIED error

    The site hasn't been added to the list of sites, or the user hasn't verified site management rights.

    {
      "error_code": "HOST_NOT_VERIFIED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    Parameter Description
    error_code Error code.
    host_id Site ID.
    error_message Error message.