# About the GSC Site Readiness API

The GSC API manages a Wix site's presence in [Google Search Console](fallback::https://search.google.com/search-console/about): it verifies the site with Google, adds it as a Search Console property, submits its sitemap, requests indexing, and reads inspection and search performance data. It acts through the Google account linked to the site with the [GSC Connection API](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/connection-v1/introduction).

With the GSC Site Readiness API, you can:

- Check how far along the site is in Google Search Console setup, and which step is still missing.
- Complete the setup steps: verify site ownership, add the site to Search Console, submit its sitemap, and request indexing.
- Retrieve the site's search performance data: clicks, impressions, click-through rate, and position.
- Inspect the site's pages with Google's URL inspection, and read the results.
- Review the history of setup events for the site.

## How Google Search Console setup works

A site becomes fully set up in Google Search Console in this order:

1. Connect a Google account, with the [GSC Connection API](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/connection-v1/introduction).
2. [Verify Site](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/verify-site): Wix proves the site's ownership to Google. For Wix sites this needs nothing from the site owner, because Wix places the `google-site-verification` meta tag on every page automatically.
3. [Add Site](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/add-site): the site becomes a property in the connected account's Search Console.
4. [Submit Sitemap](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/submit-sitemap): Wix generates and hosts the sitemap, and submits its URL to the property.
5. [Request Site Indexing](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/request-site-indexing): asks Google to crawl and index the site.

[Get Site Readiness](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/get-site-readiness) reports whether the site's Google connection and ownership verification are in place, and if not, the first step that's still blocking. It covers steps 1 and 2 above; call the property steps that follow in order yourself.

## URL inspection

Inspecting pages is a two-step, asynchronous operation. [Inspect URLs](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/inspect-urls) starts the inspection and returns the first batch of results synchronously. When pages remain, Wix keeps inspecting them server-side, and you poll [Get Inspection](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/get-inspection) until the inspection completes.

Each inspected page consumes the connected account's Google URL-inspection quota. Google allows up to 2,000 page inspections a day per property, so an inspection can finish with pages left uninspected when the quota runs out, and sites with more than 2,000 pages can't be inspected through this API at all.

## Before you begin

It's important to note the following points before starting to code:

- A Google account must be connected to the site first, with the [GSC Connection API](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/connection-v1/introduction). Methods that reach Google Search Console fail with `FAILED_PRECONDITION` (`MISSING_TOKEN`) until the connection's status is `VALID`.
- The setup methods that write to Google Search Console (Verify Site, Add Site, Submit Sitemap) require the site to be published, have a connected domain, and allow search-engine indexing. Otherwise they fail with `FAILED_PRECONDITION`.
- Calls that reach Google are subject to the property's Google API quotas. A `RESOURCE_EXHAUSTED` (`GOOGLE_QUOTA_EXCEEDED`) error is safe to retry after the quota window resets, and an `UNAVAILABLE` (`GOOGLE_UNAVAILABLE`) error is a temporary Google failure that's safe to retry with backoff.
- Search performance and inspection data come from Google Search Console, so their freshness and history range follow Google.

## Use cases

- [Set up a site in Google Search Console](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/sample-flows#set-up-a-site-in-google-search-console)
- [Show the site's search performance](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/sample-flows#show-the-sites-search-performance)
- [Inspect the site's pages](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/sample-flows#inspect-the-sites-pages)

## Terminology

- **Search Console property**: The representation of the site in Google Search Console. Add Site creates it in the connected account.
- **Site readiness**: The site's standing in Google Search Console setup, as a computed status: `READY` when setup is complete, or `NOT_READY` with the first blocking step.
- **URL inspection**: Google's per-page report of index status and issues, as returned by Google's URL Inspection API.

@sdk_package_setup

# GSC Site Readiness: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

## Set up a site in Google Search Console

A site owner wants their site verified, added to Google Search Console, submitting its sitemap, and indexed. Your app clears the readiness blockers first, then walks the site through the remaining setup steps.

> **Prerequisite:** Connect a Google account to the site with the [GSC Connection API](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/connection-v1/introduction), and wait until the connection's status is `VALID`.

To set up a site:

1. Call [Get Site Readiness](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/get-site-readiness). If `status` is `READY`, the site's connection and ownership verification are in place, so continue from step 4.
1. If `status` is `NOT_READY`, act on the returned `blockingReason`:
    - `SITE_OWNER_NOT_VERIFIED`: call [Verify Site](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/verify-site). Verification runs synchronously against Google, so allow up to a minute. If the call fails with `FAILED_PRECONDITION`, resolve the reported problem first: publish the site, connect a domain, or allow search-engine indexing.
    - `TOKEN_INVALID`: the stored Google credentials stopped working. Reconnect the Google account with the [GSC Connection API](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/connection-v1/introduction).
    - `DOMAIN_MISSING`: Google Search Console setup needs a connected domain. Have the site owner connect one before continuing.
    - `SITE_NOT_CREATED`: the site doesn't exist yet. Have the site owner create and publish it before continuing.
    - Any other value: treat the site as not ready, and don't assume a next action. New blocking reasons can be added over time.
1. Call [Get Site Readiness](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/get-site-readiness) again after each successful action, and repeat until `status` is `READY`. Read the current `blockingReason` each time instead of reusing an earlier one, because a response reports only the first step that's still blocking.
1. Call [Add Site](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/add-site) to add the site as a property in the connected account's Search Console, then call [Submit Sitemap](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/submit-sitemap). Wix generates and hosts the sitemap and submits its URL to the property. Google processes sitemaps asynchronously, so check the processing state later with [List Sitemaps](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/list-sitemaps).
1. Call [Request Site Indexing](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/request-site-indexing) to ask Google to crawl the site. A successful call means Google accepted the request into its crawl queue, not that the site is indexed.

Readiness reports the site's Google connection and ownership verification. It doesn't track the property steps in steps 4 and 5, so call those in order yourself.

## Show the site's search performance

Your app has a dashboard that shows how the site performs in Google Search: total clicks and impressions over time, and the top search queries.

To show search performance:

1. Call [Get Search Analytics](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/get-search-analytics) with `?startDate=2026-08-01&endDate=2026-08-31&dimensions=date` to get a daily row for the period. Each row's `keys` holds the date, alongside its `clicks`, `impressions`, `ctr`, and `position`.
1. Call it again with `dimensions=query` and a `rowLimit` to get the top search terms for the same period.
1. Render the daily rows as a chart and the query rows as a table. Page through large result sets with `startRow` and `rowLimit`.

## Inspect the site's pages

A site owner wants to know which of their pages are indexed by Google and which have issues. Your app runs Google URL inspection on the site's pages and presents the results.

To inspect pages:

1. Call [Inspect URLs](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/inspect-urls) with the IDs of the pages to inspect. The response contains the results of the first batch of pages.
1. If the returned `status` is `ONGOING`, Wix is still inspecting the remaining pages server-side. Poll [Get Inspection](fallback::https://dev.wix.com/docs/api-reference/business-management/seo/google-search-console/site-readiness-v1/get-inspection) every few seconds until `status` is `COMPLETE` or `ERROR`. Large inspections can take several minutes.
1. Check `remainingPageCount` in the final response. A value above zero means the connected account's Google inspection quota ran out before every page was inspected, so the missing pages can be inspected after the quota resets, using `updateResults: true` to merge the new results into the stored ones.
1. Present each result. The `page` object identifies the inspected page, and `data` carries Google's raw URL-inspection payload, including the index status verdict and any issues Google reports.

Coding Examples

Overview

Sled Tests

Go Headless

Extend Websites with SDK

Build Apps

Client (Deprecated)

API Preview

Wix CLI

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso

GraphQL (Alpha)

List Events