Regenerate GSC URL Inspections docs with detailed response schema

Author: cyberandy

docs/api/gsc-url-inspections/post-gsc-url-inspections.api.mdx

@@ -5,7 +5,7 @@ description: "Inspect a URL using Google Search Console"
 sidebar_label: "Inspect a URL using Google Search Console"
 hide_title: true
 hide_table_of_contents: true
-api: {"tags":["Google Search Console"],"operationId":"postGscUrlInspections","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The URL to inspect"}},"required":["url"]},"example":{"url":"https://www.glasses.com/gl-us/burberry/8056262081037"}}}},"responses":{"200":{"description":"Inspection request accepted / result","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"data":{"type":"object"}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Authentication Failure"}},"security":[{"ApiKey":[]}],"description":"Inspect a URL using Google Search Console","method":"post","path":"/gsc/url-inspections","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"`Key {your key}`"}},"jsonRequestBodyExample":{"url":"string"},"info":{"title":"Google Search Console - URL Inspections","version":"1.0.0","description":"API for requesting Google Search Console URL inspections via WordLift Manager API.","contact":{"name":"WordLift","url":"https://wordlift.io","email":"hello@wordlift.io"}},"postman":{"name":"Inspect a URL using Google Search Console","description":{"type":"text/plain"},"url":{"path":["gsc","url-inspections"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"<API Key>","key":"value"},{"type":"any","value":"header","key":"in"}]}}}
+api: {"tags":["Google Search Console"],"operationId":"postGscUrlInspections","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The URL to inspect"}},"required":["url"]},"example":{"url":"https://www.example.com/product/12345"}}}},"responses":{"200":{"description":"URL inspection result from Google Search Console","content":{"application/json":{"schema":{"type":"object","properties":{"inspectionResult":{"type":"object","properties":{"inspectionResultLink":{"type":"string","format":"uri","description":"Link to view the full inspection result in Google Search Console"},"indexStatusResult":{"type":"object","properties":{"verdict":{"type":"string","description":"Overall indexing verdict","enum":["PASS","FAIL","NEUTRAL"]},"coverageState":{"type":"string","description":"Current coverage state of the URL"},"robotsTxtState":{"type":"string","description":"Whether robots.txt allows indexing","enum":["ALLOWED","DISALLOWED"]},"indexingState":{"type":"string","description":"Current indexing state"},"lastCrawlTime":{"type":"string","format":"date-time","description":"Timestamp of the last crawl"},"pageFetchState":{"type":"string","description":"Status of the page fetch"},"googleCanonical":{"type":"string","format":"uri","description":"Canonical URL detected by Google"},"userCanonical":{"type":"string","format":"uri","description":"Canonical URL specified by the user"},"sitemap":{"type":"array","items":{"type":"string","format":"uri"},"description":"Sitemaps that reference this URL"},"referringUrls":{"type":"array","items":{"type":"string","format":"uri"},"description":"URLs that link to this page"},"crawledAs":{"type":"string","description":"Device type used for crawling","enum":["MOBILE","DESKTOP"]}}},"mobileUsabilityResult":{"type":"object","properties":{"verdict":{"type":"string","description":"Mobile usability verdict"}}},"richResultsResult":{"type":"object","properties":{"verdict":{"type":"string","description":"Rich results verdict","enum":["PASS","FAIL","NEUTRAL","VERDICT_UNSPECIFIED"]},"detectedItems":{"type":"array","items":{"type":"object","properties":{"richResultType":{"type":"string","description":"Type of rich result detected"},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the detected item"},"issues":{"type":"array","items":{"type":"object","properties":{"issueMessage":{"type":"string","description":"Description of the issue"},"severity":{"type":"string","description":"Severity level of the issue","enum":["WARNING","ERROR"]}}}}}}}}}}}}}}}},"example":{"inspectionResult":{"inspectionResultLink":"https://search.google.com/search-console/inspect?resource_id=sc-domain:example.com&id=3LKVoOqyHSOj12br3NiNoQ&utm_medium=link&utm_source=api","indexStatusResult":{"verdict":"PASS","coverageState":"Submitted and indexed","robotsTxtState":"ALLOWED","indexingState":"INDEXING_ALLOWED","lastCrawlTime":"2025-11-04T02:36:47Z","pageFetchState":"SUCCESSFUL","googleCanonical":"https://www.example.com/product/12345","userCanonical":"https://www.example.com/product/12345","sitemap":["https://www.example.com/sitemap.xml"],"referringUrls":["https://www.example.com/sitemap.xml","https://www.example.com/product-listing"],"crawledAs":"MOBILE"},"mobileUsabilityResult":{"verdict":"VERDICT_UNSPECIFIED"},"richResultsResult":{"verdict":"PASS","detectedItems":[{"richResultType":"Product snippets","items":[{"name":"Sample Product Name","issues":[{"issueMessage":"Missing field \"review\"","severity":"WARNING"},{"issueMessage":"Missing field \"aggregateRating\"","severity":"WARNING"}]}]},{"richResultType":"Merchant listings","items":[{"name":"Sample Product Name","issues":[{"issueMessage":"Missing field \"shippingDetails\"","severity":"WARNING"},{"issueMessage":"Missing field \"hasMerchantReturnPolicy\"","severity":"WARNING"}]}]},{"richResultType":"Breadcrumbs","items":[{"name":"Unnamed item"}]}]}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Authentication Failure"}},"security":[{"ApiKey":[]}],"description":"Inspect a URL using Google Search Console","method":"post","path":"/gsc/url-inspections","servers":[{"url":"https://api.wordlift.io"}],"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"`Key {your key}`"}},"jsonRequestBodyExample":{"url":"string"},"info":{"title":"Google Search Console - URL Inspections","version":"1.0.0","description":"API for requesting Google Search Console URL inspections via WordLift Manager API.","contact":{"name":"WordLift","url":"https://wordlift.io","email":"hello@wordlift.io"}},"postman":{"name":"Inspect a URL using Google Search Console","description":{"type":"text/plain"},"url":{"path":["gsc","url-inspections"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"<API Key>","key":"value"},{"type":"any","value":"header","key":"in"}]}}}
 sidebar_class_name: "post api-method"
 info_path: api/gsc-url-inspections/google-search-console-url-inspections
 custom_edit_url: null
@@ -28,9 +28,9 @@ Inspect a URL using Google Search Console
 
 <MimeTabs><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"The URL to inspect"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
 
-Inspection request accepted / result
+URL inspection result from Google Search Console
 
-</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"data"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"status\": \"string\",\n  \"data\": {}\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
+</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>inspectionResult</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"inspectionResultLink"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Link to view the full inspection result in Google Search Console"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>indexStatusResult</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"verdict"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`PASS`, `FAIL`, `NEUTRAL`]"} schema={{"type":"string","description":"Overall indexing verdict","enum":["PASS","FAIL","NEUTRAL"]}}></SchemaItem><SchemaItem collapsible={false} name={"coverageState"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Current coverage state of the URL"}}></SchemaItem><SchemaItem collapsible={false} name={"robotsTxtState"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ALLOWED`, `DISALLOWED`]"} schema={{"type":"string","description":"Whether robots.txt allows indexing","enum":["ALLOWED","DISALLOWED"]}}></SchemaItem><SchemaItem collapsible={false} name={"indexingState"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Current indexing state"}}></SchemaItem><SchemaItem collapsible={false} name={"lastCrawlTime"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Timestamp of the last crawl"}}></SchemaItem><SchemaItem collapsible={false} name={"pageFetchState"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Status of the page fetch"}}></SchemaItem><SchemaItem collapsible={false} name={"googleCanonical"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Canonical URL detected by Google"}}></SchemaItem><SchemaItem collapsible={false} name={"userCanonical"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"Canonical URL specified by the user"}}></SchemaItem><SchemaItem collapsible={false} name={"sitemap"} required={false} schemaName={"uri[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string","format":"uri"},"description":"Sitemaps that reference this URL"}}></SchemaItem><SchemaItem collapsible={false} name={"referringUrls"} required={false} schemaName={"uri[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string","format":"uri"},"description":"URLs that link to this page"}}></SchemaItem><SchemaItem collapsible={false} name={"crawledAs"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`MOBILE`, `DESKTOP`]"} schema={{"type":"string","description":"Device type used for crawling","enum":["MOBILE","DESKTOP"]}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>mobileUsabilityResult</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"verdict"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Mobile usability verdict"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>richResultsResult</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"verdict"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`PASS`, `FAIL`, `NEUTRAL`, `VERDICT_UNSPECIFIED`]"} schema={{"type":"string","description":"Rich results verdict","enum":["PASS","FAIL","NEUTRAL","VERDICT_UNSPECIFIED"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>detectedItems</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"richResultType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Type of rich result detected"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>items</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the detected item"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>issues</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"issueMessage"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the issue"}}></SchemaItem><SchemaItem collapsible={false} name={"severity"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`WARNING`, `ERROR`]"} schema={{"type":"string","description":"Severity level of the issue","enum":["WARNING","ERROR"]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"inspectionResult\": {\n    \"inspectionResultLink\": \"string\",\n    \"indexStatusResult\": {\n      \"verdict\": \"PASS\",\n      \"coverageState\": \"string\",\n      \"robotsTxtState\": \"ALLOWED\",\n      \"indexingState\": \"string\",\n      \"lastCrawlTime\": \"2025-11-10T17:25:37.639Z\",\n      \"pageFetchState\": \"string\",\n      \"googleCanonical\": \"string\",\n      \"userCanonical\": \"string\",\n      \"sitemap\": [\n        \"string\"\n      ],\n      \"referringUrls\": [\n        \"string\"\n      ],\n      \"crawledAs\": \"MOBILE\"\n    },\n    \"mobileUsabilityResult\": {\n      \"verdict\": \"string\"\n    },\n    \"richResultsResult\": {\n      \"verdict\": \"PASS\",\n      \"detectedItems\": [\n        {\n          \"richResultType\": \"string\",\n          \"items\": [\n            {\n              \"name\": \"string\",\n              \"issues\": [\n                {\n                  \"issueMessage\": \"string\",\n                  \"severity\": \"WARNING\"\n                }\n              ]\n            }\n          ]\n        }\n      ]\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"inspectionResult\": {\n    \"inspectionResultLink\": \"https://search.google.com/search-console/inspect?resource_id=sc-domain:example.com&id=3LKVoOqyHSOj12br3NiNoQ&utm_medium=link&utm_source=api\",\n    \"indexStatusResult\": {\n      \"verdict\": \"PASS\",\n      \"coverageState\": \"Submitted and indexed\",\n      \"robotsTxtState\": \"ALLOWED\",\n      \"indexingState\": \"INDEXING_ALLOWED\",\n      \"lastCrawlTime\": \"2025-11-04T02:36:47Z\",\n      \"pageFetchState\": \"SUCCESSFUL\",\n      \"googleCanonical\": \"https://www.example.com/product/12345\",\n      \"userCanonical\": \"https://www.example.com/product/12345\",\n      \"sitemap\": [\n        \"https://www.example.com/sitemap.xml\"\n      ],\n      \"referringUrls\": [\n        \"https://www.example.com/sitemap.xml\",\n        \"https://www.example.com/product-listing\"\n      ],\n      \"crawledAs\": \"MOBILE\"\n    },\n    \"mobileUsabilityResult\": {\n      \"verdict\": \"VERDICT_UNSPECIFIED\"\n    },\n    \"richResultsResult\": {\n      \"verdict\": \"PASS\",\n      \"detectedItems\": [\n        {\n          \"richResultType\": \"Product snippets\",\n          \"items\": [\n            {\n              \"name\": \"Sample Product Name\",\n              \"issues\": [\n                {\n                  \"issueMessage\": \"Missing field \\\"review\\\"\",\n                  \"severity\": \"WARNING\"\n                },\n                {\n                  \"issueMessage\": \"Missing field \\\"aggregateRating\\\"\",\n                  \"severity\": \"WARNING\"\n                }\n              ]\n            }\n          ]\n        },\n        {\n          \"richResultType\": \"Merchant listings\",\n          \"items\": [\n            {\n              \"name\": \"Sample Product Name\",\n              \"issues\": [\n                {\n                  \"issueMessage\": \"Missing field \\\"shippingDetails\\\"\",\n                  \"severity\": \"WARNING\"\n                },\n                {\n                  \"issueMessage\": \"Missing field \\\"hasMerchantReturnPolicy\\\"\",\n                  \"severity\": \"WARNING\"\n                }\n              ]\n            }\n          ]\n        },\n        {\n          \"richResultType\": \"Breadcrumbs\",\n          \"items\": [\n            {\n              \"name\": \"Unnamed item\"\n            }\n          ]\n        }\n      ]\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
 
 Bad Request