Skip to main content
POST
Sync a data source on a data feed

Authorizations

Authorization
string
header
required

Path Parameters

data_feed_friendly_id
string
required

The data feed's friendly ID (e.g. datafd_aBcD1234eFgH5678).

source_friendly_id
string
required

The source's friendly ID (e.g. dsrc_aBcD1234eFgH5678).

Response

Fetch started; returns the new run.

A data feed run.

id
string

The data feed run's friendly ID.

Example:

"run_aBcD1234eFgH5678"

data_feed_id
string

The data feed's friendly ID.

Example:

"datafd_aBcD1234eFgH5678"

stage
enum<string>
Available options:
collection,
transformation,
publication,
completed
status
enum<string>
Available options:
running,
failed,
retrying,
reversing,
reversed,
reversal_failed,
paused,
complete
error_message
string | null

Why the run failed, or why a retry or revert was refused, or null.

error_code
enum<string> | null

Why the run failed, as a stable code; rate_limited when the provider limited requests, otherwise null.

Available options:
rate_limited,
null
next_fetch_at
string<date-time> | null

Earliest time the automatic retry or next capped window is due, derived from current source settings. Null when nothing follows this run, including when a newer run exists or daily_fetch is off. This does not confirm a job is queued. A past time can mean the follow-up is queued, delayed or missed; the next daily fetch can recover it.

steps
object[]

The steps created so far, in stage order.

events_count
integer

Number of events the run has created.

started_at
string<date-time> | null

When collection started; null until a worker picks the run up.

finished_at
string<date-time> | null
created_at
string<date-time>