> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # InspectUrl # Package: googleSearchConsole # Namespace: GscService # Method link: https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/inspect-url.md ## Permission Scopes: View SEO Settings: SCOPE.PROMOTE.VIEW-SEO ## Introduction Runs Google URL inspection on a single URL and returns the result. The call is synchronous and stores nothing, and the URL doesn't have to be a page of a Wix site. To inspect many pages of a Wix site by page ID in the background, use Inspect URLs instead. Each call consumes Google URL-inspection quota for the connected account: up to 2,000 inspections a day per property. --- ## REST API ### Schema ``` Method: inspectUrl Description: Runs Google URL inspection on a single URL and returns the result. The call is synchronous and stores nothing, and the URL doesn't have to be a page of a Wix site. To inspect many pages of a Wix site by page GUID in the background, use Inspect URLs instead. Each call consumes Google URL-inspection quota for the connected account: up to 2,000 inspections a day per property. URL: https://www.wixapis.com/gsc/connection/v1/url-inspection Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: url Method parameters: query param name: siteUrl | type: siteUrl | description: URL of a site that isn't hosted on Wix, exactly as its URL-prefix property appears in Google Search Console. For example, `https://example.com/`. Leave empty for the Wix site the call is made on: setting it for a Wix site fails with `INVALID_ARGUMENT`. Domain properties (`sc-domain:example.com`) aren't supported. | validation: format WEB_URL query param name: url | type: url | description: Full URL to inspect. Must belong to the site the call is made on, or to `siteUrl` when it's set. | required: true | validation: format WEB_URL Return type: InspectUrlResponse - name: data | type: object | description: Google's raw URL-inspection result for the URL, as returned by the Google Search Console [URL Inspection API](https://developers.google.com/webmaster-tools/v1/urlInspection.index/inspect). Any human-readable text in this payload (issue descriptions and the like) is in English. Verdicts and states are stable identifiers, so localize from those rather than from the text. Possible Errors: HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: SITE_PROPERTY_NOT_OWNED | Description: `siteUrl` is set and the connected Google account doesn't own that Search Console property. Verify it in Google Search Console first. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: MISSING_TOKEN | Description: No Google account is connected for this site. Connect first with the GSC Connection API. HTTP Code: 429 | Status Code: RESOURCE_EXHAUSTED | Application Code: GOOGLE_QUOTA_EXCEEDED | Description: Google's API quota for the property is used up. Retry after the quota window resets. HTTP Code: 503 | Status Code: UNAVAILABLE | Application Code: GOOGLE_UNAVAILABLE | Description: Google answered with a temporary server error. Retry with backoff. ``` ### Examples ### Inspect URL ```curl curl -X GET \ 'https://www.wixapis.com/gsc/v1/url-inspection?url=https%3A%2F%2Fwww.my-fashion-store.com%2Fabout' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.gsc.siteReadiness.inspectUrl(url, options) Description: Runs Google URL inspection on a single URL and returns the result. The call is synchronous and stores nothing, and the URL doesn't have to be a page of a Wix site. To inspect many pages of a Wix site by page GUID in the background, use Inspect URLs instead. Each call consumes Google URL-inspection quota for the connected account: up to 2,000 inspections a day per property. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: url Method parameters: param name: options | type: InspectUrlOptions none - name: siteUrl | type: string | description: URL of a site that isn't hosted on Wix, exactly as its URL-prefix property appears in Google Search Console. For example, `https://example.com/`. Leave empty for the Wix site the call is made on: setting it for a Wix site fails with `INVALID_ARGUMENT`. Domain properties (`sc-domain:example.com`) aren't supported. | validation: format WEB_URL param name: url | type: string | description: Full URL to inspect. Must belong to the site the call is made on, or to `siteUrl` when it's set. | required: true | validation: format WEB_URL Return type: PROMISE - name: data | type: object | description: Google's raw URL-inspection result for the URL, as returned by the Google Search Console [URL Inspection API](https://developers.google.com/webmaster-tools/v1/urlInspection.index/inspect). Any human-readable text in this payload (issue descriptions and the like) is in English. Verdicts and states are stable identifiers, so localize from those rather than from the text. Possible Errors: HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: SITE_PROPERTY_NOT_OWNED | Description: `siteUrl` is set and the connected Google account doesn't own that Search Console property. Verify it in Google Search Console first. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: MISSING_TOKEN | Description: No Google account is connected for this site. Connect first with the GSC Connection API. HTTP Code: 429 | Status Code: RESOURCE_EXHAUSTED | Application Code: GOOGLE_QUOTA_EXCEEDED | Description: Google's API quota for the property is used up. Retry after the quota window resets. HTTP Code: 503 | Status Code: UNAVAILABLE | Application Code: GOOGLE_UNAVAILABLE | Description: Google answered with a temporary server error. Retry with backoff. ``` ### Examples ### Run Google URL inspection on a single URL ```javascript import { siteReadiness } from "@wix/gsc"; async function inspectUrl() { const response = await siteReadiness.inspectUrl( "https://www.my-fashion-store.com/about" ); } /* Promise resolves to: * { * "data": { * "inspectionResultLink": "https://search.google.com/search-console/inspect?resource_id=https://www.my-fashion-store.com/&id=hLlpxJLVEH5J6ktjw640Aw&utm_medium=link&utm_source=api", * "indexStatusResult": { * "verdict": "PASS", * "coverageState": "Submitted and indexed", * "robotsTxtState": "ALLOWED", * "indexingState": "INDEXING_ALLOWED", * "lastCrawlTime": "2026-09-27T11:47:03Z", * "pageFetchState": "SUCCESSFUL", * "googleCanonical": "https://www.my-fashion-store.com/about", * "userCanonical": "https://www.my-fashion-store.com/about" * }, * "mobileUsabilityResult": { * "verdict": "VERDICT_UNSPECIFIED" * } * } * } */ ``` ### inspectUrl (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { siteReadiness } from '@wix/gsc'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { siteReadiness }, // Include the auth strategy and host as relevant }); async function inspectUrl(url,options) { const response = await myWixClient.siteReadiness.inspectUrl(url,options); }; ``` ---