{
  "url": "https://telipot.com/catalog/tasks/google-search-console.url.inspect",
  "id": "google-search-console.url.inspect",
  "name": "Index status, canonical and last crawl of a URL on a site",
  "provider": {
    "slug": "google-search-console",
    "name": "Google Search Console"
  },
  "capability": "search-console.url.inspect",
  "platform": "search-console",
  "kind": "data",
  "tier": "core",
  "identity": "account",
  "identityLabel": "Company account",
  "price": {
    "amount": "Free",
    "state": "free",
    "label": "Free",
    "detail": "Free from the tool",
    "type": "free"
  },
  "providers": 1,
  "retention": "standard",
  "runsOn": "free",
  "live": true,
  "summary": "Index inspection.",
  "method": "POST",
  "path": "/v1/urlInspection/index:inspect",
  "host": "https://searchconsole.googleapis.com",
  "docsUrl": "https://developers.google.com/webmaster-tools/v1/urlInspection.index/inspect",
  "auth": {
    "scheme": "oauth",
    "label": "oauth · OAuth 2.0 with PKCE",
    "short": "oauth · OAuth 2.0"
  },
  "scope": "own_account",
  "principal": "organization",
  "requiredScopes": [
    "webmasters.readonly"
  ],
  "verification": {
    "state": "none",
    "label": "Not verified yet",
    "detail": "Not checked yet. We test with a real request before we mark it."
  },
  "input": [
    {
      "name": "inspectionUrl",
      "location": "body",
      "type": "string",
      "required": true,
      "constraints": [],
      "note": "The URL to inspect, which must be under the property named in siteUrl"
    },
    {
      "name": "siteUrl",
      "location": "body",
      "type": "string",
      "required": true,
      "constraints": [],
      "note": "The property as sites.list returns it, a URL-prefix property with its trailing slash or a domain property written sc-domain:example.com"
    },
    {
      "name": "languageCode",
      "location": "body",
      "type": "string",
      "required": false,
      "constraints": [
        "default \"en-US\""
      ],
      "note": "An IETF BCP-47 code for the language of the translated issue messages"
    }
  ],
  "sampleInput": {
    "inspectionUrl": "https://www.example.com/pricing",
    "siteUrl": "sc-domain:example.com"
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "inspectionUrl": {
        "type": "string",
        "description": "The URL to inspect, which must be under the property named in siteUrl",
        "examples": [
          "https://www.example.com/pricing"
        ]
      },
      "siteUrl": {
        "type": "string",
        "description": "The property as sites.list returns it, a URL-prefix property with its trailing slash or a domain property written sc-domain:example.com",
        "examples": [
          "sc-domain:example.com"
        ]
      },
      "languageCode": {
        "type": "string",
        "description": "An IETF BCP-47 code for the language of the translated issue messages",
        "default": "en-US"
      }
    },
    "required": [
      "inspectionUrl",
      "siteUrl"
    ],
    "additionalProperties": false
  },
  "output": [
    {
      "name": "inspectionResult",
      "type": "object"
    }
  ],
  "outputSchema": {
    "type": "object",
    "required": [
      "inspectionResult"
    ],
    "properties": {
      "inspectionResult": {
        "type": "object",
        "required": [
          "inspectionResultLink"
        ],
        "properties": {
          "inspectionResultLink": {
            "type": "string",
            "description": "The URL inspection page in Search Console"
          },
          "indexStatusResult": {
            "type": "object",
            "properties": {
              "verdict": {
                "type": "string",
                "description": "PASS when the URL is indexed, PARTIAL, FAIL or NEUTRAL"
              },
              "coverageState": {
                "type": "string",
                "description": "Whether Google could find and index the page in words"
              },
              "robotsTxtState": {
                "type": "string",
                "description": "ALLOWED or DISALLOWED"
              },
              "indexingState": {
                "type": "string",
                "description": "INDEXING_ALLOWED, or the noindex rule that blocks it"
              },
              "pageFetchState": {
                "type": "string",
                "description": "Whether Google could retrieve the page such as SUCCESSFUL or NOT_FOUND"
              },
              "lastCrawlTime": {
                "type": "string",
                "description": "RFC 3339 time; absent when the URL was never crawled"
              },
              "googleCanonical": {
                "type": "string",
                "description": "The canonical Google selected; absent when the page is not indexed"
              },
              "userCanonical": {
                "type": "string",
                "description": "The canonical the page declares"
              },
              "crawledAs": {
                "type": "string",
                "description": "DESKTOP or MOBILE"
              },
              "sitemap": {
                "type": "array",
                "description": "Sitemaps Google knows list this URL",
                "items": {
                  "type": "string"
                }
              },
              "referringUrls": {
                "type": "array",
                "description": "URLs that link to this URL",
                "items": {
                  "type": "string"
                }
              }
            }
          },
          "richResultsResult": {
            "type": "object",
            "description": "Absent when no rich result was found"
          },
          "ampResult": {
            "type": "object",
            "description": "Absent when the page is not an AMP page"
          }
        }
      }
    }
  },
  "example": {
    "file": "examples/google-search-console.url.inspect.json",
    "json": {
      "inspectionResult": {
        "inspectionResultLink": "https://search.google.com/search-console/inspect?resource_id=sc-domain%3Aexample.com&id=EXAMPLE",
        "indexStatusResult": {
          "verdict": "PASS",
          "coverageState": "Submitted and indexed",
          "robotsTxtState": "ALLOWED",
          "indexingState": "INDEXING_ALLOWED",
          "pageFetchState": "SUCCESSFUL",
          "lastCrawlTime": "2026-10-02T04:12:09Z",
          "googleCanonical": "https://www.example.com/pricing",
          "userCanonical": "https://www.example.com/pricing",
          "crawledAs": "MOBILE",
          "sitemap": [
            "https://www.example.com/sitemap.xml"
          ]
        }
      }
    }
  },
  "commands": {
    "mode": "run",
    "cli": "telipot run google-search-console.url.inspect \\\n  --input-json '{\"inspectionUrl\":\"https://www.example.com/pricing\",\"siteUrl\":\"sc-domain:example.com\"}'",
    "http": "curl https://api.telipot.com/v1/tasks/google-search-console.url.inspect/run \\\n  -H \"Authorization: Bearer $TELIPOT_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"inspectionUrl\":\"https://www.example.com/pricing\",\"siteUrl\":\"sc-domain:example.com\"}'",
    "quote": "telipot run google-search-console.url.inspect \\\n  --input-json '{\"inspectionUrl\":\"https://www.example.com/pricing\",\"siteUrl\":\"sc-domain:example.com\"}' \\\n  --quote"
  },
  "siblings": []
}
