'An experimental API for testing the mobile-friendliness of a URL'

Method: inspectionTools.index.inspect

Stay organized with collections Save and categorize content based on your preferences.

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/inspectionTools/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. URL to inspect. Must be under the property specified in "siteUrl".

siteUrl

string

Required. The URL of the property as defined in Search Console. Examples: http://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:

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

object (UrlInspectionResult)

URL inspection results.