Developer API

GSC snapshot field reference

Cached Google Search Console data exposed by gsc:read and refreshed with gsc:write (POST /properties/:id/gsc/sync).

Connect first: OAuth and property linking happen in the web app. The API reads MongoDB snapshots — it does not run Google OAuth.

Endpoints

GET /properties/:id/gsc — full snapshot + history
GET /properties/:id/gsc/overview — status + 28-day totals only
GET /properties/:id/gsc/queries — paginated topQueries
GET /properties/:id/gsc/pages — paginated topPages
GET /organization/gsc — portfolio totals across linked properties

status object

Field	Description
`orgConnected`	Organization-level GSC OAuth token is present and not revoked
`propertyLinked`	This website is linked to a GSC property URL
`gscSiteUrl`	Linked Search Console property (domain or URL-prefix)
`lastSyncAt`	When the cached snapshot was last refreshed
`tokenStatus`	`ok`, `missing`, or `revoked`
`lastSyncError`	Last sync failure message, if any

snapshot object

Present when the property is linked and at least one sync succeeded.

totals

Aggregate metrics for the snapshot date range (typically 28 days).

Field	Type
`clicks`	integer
`impressions`	integer
`ctr`	float (0–1)
`position`	float (average position)

daily

Array of daily totals: { date, clicks, impressions, ctr, position }.

topQueries

Array of query rows: query, clicks, impressions, ctr, position. Use GET …/gsc/queries?limit=25&cursor=… for pagination.

topPages

Same shape as queries but keyed by page URL instead of query text.

crawlCorrelation

URLs that appear in both GSC top pages and recent crawl results, with GSC clicks/impressions and latest crawl score. Useful for prioritizing fixes on high-traffic pages with low technical scores.

indexSummary

Indexing coverage summary from Search Console (valid, warning, error counts when available).

urlIndexStatus

Per-URL indexing status samples from the linked property.

Example

curl -H "Authorization: Bearer xf_live_..." \
  https://api.xenonflare.com/api/v1/properties/PROPERTY_ID/gsc/overview

← Developer API reference