/v1/urlInspection/index:inspect

POST

urlInspection

Index inspection.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://searchconsole.googleapis.com//v1/urlInspection/index:inspect' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

{
  "inspectionResult": {
    "ampResult": {
      "ampIndexStatusVerdict": "VERDICT_UNSPECIFIED",
      "ampUrl": "string",
      "indexingState": "AMP_INDEXING_STATE_UNSPECIFIED",
      "issues": [
        {
          "issueMessage": "string",
          "severity": "SEVERITY_UNSPECIFIED"
        }
      ],
      "lastCrawlTime": "string",
      "pageFetchState": "PAGE_FETCH_STATE_UNSPECIFIED",
      "robotsTxtState": "ROBOTS_TXT_STATE_UNSPECIFIED",
      "verdict": "VERDICT_UNSPECIFIED"
    },
    "indexStatusResult": {
      "coverageState": "string",
      "crawledAs": "CRAWLING_USER_AGENT_UNSPECIFIED",
      "googleCanonical": "string",
      "indexingState": "INDEXING_STATE_UNSPECIFIED",
      "lastCrawlTime": "string",
      "pageFetchState": "PAGE_FETCH_STATE_UNSPECIFIED",
      "referringUrls": [
        "string"
      ],
      "robotsTxtState": "ROBOTS_TXT_STATE_UNSPECIFIED",
      "sitemap": [
        "string"
      ],
      "userCanonical": "string",
      "verdict": "VERDICT_UNSPECIFIED"
    },
    "inspectionResultLink": "string",
    "mobileUsabilityResult": {
      "issues": [
        {
          "issueType": "MOBILE_USABILITY_ISSUE_TYPE_UNSPECIFIED",
          "message": "string",
          "severity": "SEVERITY_UNSPECIFIED"
        }
      ],
      "verdict": "VERDICT_UNSPECIFIED"
    },
    "richResultsResult": {
      "detectedItems": [
        {
          "items": [
            {
              "issues": [
                {
                  "issueMessage": "string",
                  "severity": "SEVERITY_UNSPECIFIED"
                }
              ],
              "name": "string"
            }
          ],
          "richResultType": "string"
        }
      ],
      "verdict": "VERDICT_UNSPECIFIED"
    }
  }
}

Request

Body Params application/json

Index inspection request.

inspectionUrl

string

optional

Required. URL to inspect. Must be under the property specified in "site_url".

languageCode

string

optional

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".

siteUrl

string

optional

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.

Examples

Responses

🟢200Successful response

application/json

Body

Index-Status inspection response.

inspectionResult

object (UrlInspectionResult)

optional

URL inspection results.

ampResult

object (AmpInspectionResult)

optional

Result of the AMP analysis. Absent if the page is not an AMP page.

indexStatusResult

object (IndexStatusInspectionResult)

optional

Result of the index status analysis.

inspectionResultLink

string

optional

Link to Search Console URL inspection.

mobileUsabilityResult

object (MobileUsabilityInspectionResult)

optional

Result of the Mobile usability analysis.

richResultsResult

object (RichResultsInspectionResult)

optional

Result of the Rich Results analysis. Absent if there are no rich results found.

Modified at 2023-08-15 09:03:48

/v1/urlTestingTools/mobileFriendlyTest:run