Sync data to a sheet, base or warehouse

Embed
Preview of the card
<a href="https://seolyticize.com/docs/ref-create-data-sync"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/434224e0-e1d5-47ed-aff6-d07da87e507d/social-card.svg?v=3e7ae33eec8b" alt="Sync data to a sheet, base or warehouse" width="600" height="315"></a>
POSThttps://seolyticize.com/api/v1/tools/create_data_sync

Copies any dataset query (the query_data shape; see describe_datasets) to the client's Google Sheet (spreadsheetId, sheet), Airtable table (baseId, table — its fields named as the columns) or BigQuery table (projectId, datasetId, tableId — created on first run) on a schedule: daily, weekly or monthly at a UTC hour. replace swaps the contents each run; append adds rows, and with windowDays reads only the last N days ending yesterday so no day is added twice. Needs that destination connected first (get_integration_connect_link for Google, connect_integration for Airtable). Answers 'put our Search Console pages in a sheet every Monday', 'send the analytics to BigQuery daily'. Free.

Parameters

Idempotency-Keystringheader
Any unique string, up to 200 characters. A retry with the same key and body is answered from the first answer (Idempotent-Replayed: true) for a day, so it never buys or writes twice; the same key with another body is refused.

Request body

application/json
clientIdstringrequired
destinationstringrequired
google_sheets | airtable | bigquery
namestringrequired
queryobjectrequired
The same query query_data takes, without clientId: see describe_datasets.
Show child parameters
datasetstringrequired
gsc | web_events | crawl_pages | crawl_issues | crawl_links | rank_captures | backlinks | revenue_orders | web_agent_visits
dimensionsstring[]
= []
metricsstring[]
= []
columnsstring[]
filtersobject[]
= []
Show child parameters
columnstringrequired
opstringrequired
eq | neq | contains | not_contains | starts_with | gt | gte | lt | lte | in | regex
valuestring | number | boolean | string | number[]required
fromstring
= null
tostring
= null
orderByobject[]
= []
Show child parameters
fieldstringrequired
descboolean
= true
limitinteger
crawlIdstring
= latest
modestring
append | replace = replace
windowDaysinteger
= null
cadencestring
daily | weekly | monthly = daily
runHourinteger
= 6
spreadsheetIdstring
= null
sheetstring
= null
baseIdstring
= null
tablestring
= null
projectIdstring
= null
datasetIdstring
= null
tableIdstring
= null
{
  "clientId": "string",
  "destination": "google_sheets",
  "name": "string",
  "query": {
    "dataset": "gsc",
    "dimensions": [],
    "metrics": [],
    "columns": [
      "string"
    ],
    "filters": [],
    "from": null,
    "to": null,
    "orderBy": [],
    "limit": 0,
    "crawlId": "latest"
  },
  "mode": "replace",
  "windowDays": null,
  "cadence": "daily",
  "runHour": 6,
  "spreadsheetId": null,
  "sheet": null,
  "baseId": null,
  "table": null,
  "projectId": null,
  "datasetId": null,
  "tableId": null
}

Code samples

cURL
curl -X POST "https://seolyticize.com/api/v1/tools/create_data_sync" \
  -H "Authorization: Bearer $SEOLYTICIZE_API_KEY" \
  -H "Idempotency-Key: <value>" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","destination":"google_sheets","name":"string","query":{"dataset":"gsc","dimensions":[],"metrics":[],"columns":["string"],"filters":[],"from":null,"to":null,"orderBy":[],"limit":0,"crawlId":"latest"},"mode":"replace","windowDays":null,"cadence":"daily","runHour":6,"spreadsheetId":null,"sheet":null,"baseId":null,"table":null,"projectId":null,"datasetId":null,"tableId":null}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 The tool's result under data, and its meta.
Example
{
  "data": {},
  "meta": {
    "requestId": "string",
    "costMicros": 0,
    "cached": true,
    "cachedFrom": "string",
    "dataAsOf": "string",
    "sources": [
      "string"
    ],
    "partial": true,
    "next": [
      {
        "tool": "string",
        "args": {},
        "why": "string"
      }
    ],
    "nextCursor": "string",
    "dryRun": true
  }
}
Schema
datarequired
metaobjectrequired
Beside every answer: what it cost, whether it came from cache, how fresh it is, whether it is complete, and what to call next.
Show child parameters
requestIdstringrequired
costMicrosintegerrequired
Charged by this call, micro-USD (1,000,000 = $1).
cachedbooleanrequired
True when nothing was bought.
cachedFromstring
When the oldest cached answer used was bought.
dataAsOfstring
sourcesstring[]
partialbooleanrequired
True when the data is incomplete: a running crawl, unfinished days, unread pages.
nextobject[]required
Show child parameters
toolstring
argsobject
whystring
nextCursorstring
Pass as cursor for the next page.
dryRunboolean
Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
X-Request-Idstring
The id to quote about this request.
400 The body was not JSON or did not match the tool's input schema.
Example
{
  "error": "string",
  "code": "string",
  "next": "string",
  "requestId": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
codestring
A stable snake_case reason to branch on; GET /api/v1/errors lists them all.
nextstring
The call or step that fixes it, when there is one.
requestIdstring
Quote it when asking about a failure.
Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
401 No key, or a key that is unknown or revoked.

Same as 400 · POST /api/v1/tools/create_data_sync

Headers
WWW-Authenticatestring
403 The key's role does not permit the tool, or the key may not reach the named client.

Same as 400 · POST /api/v1/tools/create_data_sync

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
404 No tool by that name.

Same as 400 · POST /api/v1/tools/create_data_sync

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
409 A request with this Idempotency-Key is still running.

Same as 400 · POST /api/v1/tools/create_data_sync

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
422 A well-formed request the product declined, with the reason — a duplicate name, a plan limit, nothing configured to run.

Same as 400 · POST /api/v1/tools/create_data_sync

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
429 This key has used its window.

Same as 400 · POST /api/v1/tools/create_data_sync

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
Retry-Afterinteger
Seconds to wait before retrying.
500 The request could not be completed.

Same as 400 · POST /api/v1/tools/create_data_sync

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
Updated