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

NameRequiredTypeDefault valueDescription
user-idYesint64The user ID.
host-idYeshost idSite ID.

Response format

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

Example

ParameterDescription
ticThe TIC of the site.
downloaded_pages_countThe number of pages loaded by the Yandex robot.
excluded_pages_countThe number of excluded pages.
searchable_pages_countThe number of pages in search.
site_problemsThe number of problems found on the site, grouped by severity (see Error severity).

Error severity (SiteProblemSeverityEnum)

CodeDescription
FATALFatal errors.
CRITICALCritical problems.
POSSIBLE_PROBLEMPossible issues.
RECOMMENDATIONRecommendations.

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."
}
ParameterDescription
error_codeError code.
available_user_idID of the user who allowed access.
error_messageError 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"
    }
    ParameterDescription
    error_codeError code.
    host_idSite ID.
    error_messageError 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"
    }
    ParameterDescription
    error_codeError code.
    host_idSite ID.
    error_messageError 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"
    }
    ParameterDescription
    error_codeError code.
    host_idSite ID.
    error_messageError message.