GSC: 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.

To set up a site:

1. Call Get Site Readiness. If status is READY, the site's connection and ownership verification are in place, so continue from step 4.
2. If status is NOT_READY, act on the returned blockingReason:
   • SITE_OWNER_NOT_VERIFIED: call 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.
   • 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.
3. Call 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.
4. Call Add Site to add the site as a property in the connected account's Search Console, then call 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.
5. Call 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 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.
2. Call it again with dimensions=query and a rowLimit to get the top search terms for the same period.
3. 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 with the IDs of the pages to inspect. The response contains the results of the first batch of pages.
2. If the returned status is ONGOING, Wix is still inspecting the remaining pages server-side. Poll Get Inspection every few seconds until status is COMPLETE or ERROR. Large inspections can take several minutes.
3. 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.
4. 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.