Guides
Export Search Console data
XenonFlare caches Google Search Console performance in your workspace after read-only OAuth. Use gsc:read on the Developer API to pull JSON snapshots into your own pipelines — BI tools, data lakes, or CSV files. We do not ship a proprietary Amazon Redshift, BigQuery, or Qlik connector.
No native warehouse connector — pull JSON via gsc:read and load your own ETL.
Recommended export flow
- Connect GSC at org or property level in the web app.
- Optional:
POST /properties/:id/gsc/syncto refresh before export (requiresgsc:write). GET /properties/:id/gsc/overviewfor 28-day totals.- Paginate
GET /properties/:id/gsc/queriesand…/gsc/pageswithlimitandcursor. - Transform JSON in your worker and write CSV, Parquet, or warehouse tables.
Quick curl examples
curl -s -H "Authorization: Bearer $XF_API_KEY" \
https://api.xenonflare.com/api/v1/properties/$XF_PROPERTY_ID/gsc/overviewBulk & portfolio export
GET /organization/gsc— portfolio roll-up across linked properties (samegsc:readscope).- Loop properties from
GET /properties?include=gscand pull each snapshot nightly. - Use
crawlCorrelationin the full snapshot to join GSC traffic with latest crawl scores — see GSC + crawl correlation.
Webhooks (crawl jobs, not GSC rows)
Developer webhooks fire on job.completed and job.failedafter SEO scans — useful to chain “refresh GSC → queue crawl → export snapshot” in your worker. Webhooks do not stream individual GSC query rows; pull GSC via the REST endpoints above after sync.
Setup: Developer API → Webhooks section · scopes webhooks:read / webhooks:write.
Loading Redshift, BigQuery, or Snowflake
Treat XenonFlare as the source API, not the warehouse loader. Typical agency pattern:
- Nightly cron calls
gsc/syncthengsc/querieswith pagination. - Write newline JSON to S3 or GCS, then COPY/LOAD into your tables.
- Store
propertyId,date,query, clicks, impressions, CTR, position.
Field reference: GSC snapshot field reference.
Enterprise needs
Need higher rate limits, dedicated sync cadence, or a custom export contract? Contact [email protected] or see Enterprise. JSON export via API is available on standard paid plans with Developer API access.
Related
- GSC field reference
- Search Console integration
- GSC + crawl correlation
- Agency portfolio monitoring
- Developer API reference
- Idempotency guide
- Site audit API
- SEO automation API
Create an API key
Create a Starter+ workspace, connect Search Console, and add gsc:read to your API key for JSON export.
Developer API access requires Starter, Growth, or Agency. Free tier includes the web app and free marketing tools — not API keys.