Create an export

Creates an export and its destination atomically. The organization is
taken from the API key; the project_id in the body must belong to it,
as must the destination's integration_id. The export name must be
unique within the project. For a weekly schedule, run_day_of_week
is required.

Include additional_destinations to deliver to more than one
destination from the start; each entry is the same destination shape as
destination and is written in the same transaction. Only valid
alongside destination; an export can have at most 5 destinations
total, each on a different connection. Marketplace destinations
cannot be combined with others, and a DelivrDSP destination can only be
the export's first (primary) destination.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

The project to create the export in. Must belong to the key's organization.

string
required
length ≥ 1

Export name, unique within the project.

string
query
object
required

What to export. The server adds the destination (and recordLimit,
if record_limit is supplied) into this object before saving.

record_limit
object

Optional cap on the number of records delivered, and what to do when a run exceeds it.

string
enum

Delivery cadence: one_time, daily, or weekly.

Allowed:
boolean

Whether the export runs on its schedule. Defaults to true.

string

Stop running after this date (YYYY-MM-DD, UTC).

string

Time of day to run, HH:MM, in run_timezone (UTC when that is omitted).

integer
0 to 6

Day to run a weekly export, in run_timezone: 0 = Sunday, 6 = Saturday. Required when schedule is weekly.

string

IANA time zone that run_time and run_day_of_week are local to, such as America/New_York. The export then runs at that local time all year, moving with daylight saving. Omit for UTC.

destination
required

Where and how to deliver. The type field selects the variant, and integration_id references a saved integration of that type.

additional_destinations
array of objects

Further destinations to write in the same transaction as destination. Only accepted alongside destination, and only on create; an export can have at most 5 destinations total, each on a different connection.

additional_destinations
Responses

401

Missing or invalid API key / secret.

413

Request body larger than 1 MiB.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json