Method: index.inspect

  • View the index status of a URL within Google Search Console, but presently only for the version in the Google index.

  • Send an HTTP POST request to https://searchconsole.googleapis.com/v1/urlInspection/index:inspect with the URL, site URL, and optional language code in the request body.

  • Receive a response with the UrlInspectionResult object detailing the URL's index status.

  • Requires authorization with either the webmasters or webmasters.readonly scope.

View the indexed, or indexable, status of the provided URL. Presently only the status of the version in the Google index is available; you cannot test the indexability of a live URL.

HTTP request

POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "inspectionUrl": string,
  "siteUrl": string,
  "languageCode": string
}
Fields
inspectionUrl

string

Required. Fully-qualified URL to inspect. Must be under the property specified in "siteUrl".
siteUrl

string

Required. The URL of the property as defined in Search Console. Note that URL-prefix properties must include a trailing / mark. Examples: https://www.example.com/ for a URL-prefix property, or sc-domain:example.com for a Domain property.
languageCode

string

Optional. An IETF BCP-47 language code representing the requested language for translated issue messages, e.g. "en-US", "or "de-CH". Default value is "en-US".

Response body

If successful, the response body contains data with the following structure:

Index-Status inspection response.

JSON representation 
{
  "inspectionResult": {
    object (UrlInspectionResult)
  }
}
Fields
inspectionResult

object (UrlInspectionResult)

URL inspection results.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/webmasters
  • https://www.googleapis.com/auth/webmasters.readonly

For more information, see the OAuth 2.0 Overview.