API Reference

Create an export

post
https://api.delivr.ai/api/v1/exports

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.

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. {"maxRecords": <whole number, <= 10000000>}.

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 UTC.

integer
0 to 6

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

destination
required

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

Responses

401

Missing or invalid API key / secret.

413

Request body larger than 1 MiB.

Updated about 1 hour ago

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

Updated about 1 hour ago