POST
/
api
/
v1
/
exports
Create Export Job
curl --request POST \
  --url https://api.drip.re/api/v1/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "modelType": "currencies",
  "format": "CSV",
  "columns": [
    "<string>"
  ],
  "filters": {},
  "realmId": "<string>"
}'
{
  "id": "<string>",
  "jobId": "<string>",
  "status": "<string>",
  "name": "<string>",
  "modelType": "<string>",
  "format": "<string>",
  "progress": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API Key

Body

application/json
modelType
enum<string>
required

Type of data to export

Available options:
currencies,
users,
app-installs
format
enum<string>
default:CSV
required

Export format

Available options:
CSV,
JSON,
XLSX
columns
string[]
required

Columns to include in export

Minimum length: 1
name
string

Human-readable name for the export

filters
object

Filters to apply to the data

realmId
string

Realm ID for scoped exports

Response

Default Response

id
string
jobId
string
status
string
name
string | null
modelType
string
format
string
progress
number
createdAt
string<date-time>
expiresAt
string<date-time>