API reference

Jobs & exports

Track refreshes, notifications and exports.

Background work

Refresh, notification and export requests return HTTP 202 with a job ID and status_url. Poll GET /api/v1/projects/{project_id}/jobs/{id}. States are queued, running, complete, failed and cancelled.

Queued work rechecks permissions before execution. Removing access prevents further authorized work; an external request already in flight may complete. Push delivery is never automatically repeated after an ambiguous network failure.

If a write returns request_pending, inspect the dashboard or existing job before retrying. Do not use a new idempotency key to force a repeat.

Download filtered data

POST this body to /api/v1/projects/{project_id}/exports. Completed exports provide an authenticated download URL. The download checks your current access again. Export filters are limited to 100,000 records; narrow larger requests. CSV cells are escaped to prevent spreadsheet formula execution.

json

{
  "dataset": "posts",
  "format": "csv",
  "query": {
    "fields": [
      "id",
      "creator_id",
      "platform",
      "views"
    ],
    "filters": [
      {
        "field": "views",
        "op": "gte",
        "value": 10000
      }
    ]
  }
}