Skip to main content
POST
Export complete datasets for selected source sections
Streams complete datasets for selected source sections using newline-delimited JSON (application/x-ndjson). Periodic heartbeat events { "type": "heartbeat" } are sent while the export prepares, followed by a { "type": "complete", "data": ... } or { "type": "error", "message": string } event.

Supported Sources and Sections

provider applies to the analytics source only and defaults to ga.

Validation Errors

Requests are validated before streaming starts, so these failures return a plain JSON 400, not an NDJSON event:
  • Invalid export sections or date range. - a section is not allowed for the source, startDate is after endDate, selection.section is not allowed for the source, or a selection has no section (only ai-visibility and outreach may omit it).
  • This export section does not support row selection.

Row Selection

selection limits the export to chosen rows. These sections accept it:

Response Keys

The keys inside complete.data are not always the section names. Other sections use their own name as the key. If a source returns truncated data, the stream ends with an error event instead of partial data.

Authorizations

Authorization
string
header
required

Your SnowSEO API key (sk_...).

Body

application/json
teamId
string
required

Team ID.

Minimum string length: 1
source
enum<string>
required

Which product's data to export.

Available options:
gsc,
bing,
analytics,
rank-tracking,
ai-visibility,
outreach,
on-page-seo
sections
string[]
required

Sections of the source to include. Each source allows its own set.

Minimum array length: 1
endDate
string<date>
required

End of the period.

startDate
string<date>

Start of the period. Omit for All Time (from the first data). on-page-seo ignores it and exports the current audit.

provider
enum<string>

Analytics provider for the analytics source.

Available options:
ga,
posthog,
plausible,
snow
filters
object

Source-specific filters, the same ones the matching table applies.

selection
object

Export only these row IDs, or every row except these.

Response

200

Default Response