Sign in

v1

latestOpenAPI 3.0.0MIT2026-07-2620028.0 KB

Trigger an Export Job

post/api/v1/analytics/exports

Headers

Content-Typestring

The content type of the request body. Must be application/json.

Acceptstring

The content type of the response body. Must be application/json.

Request body

fromstring
tostring
emailsstring[]
event_typestring[]
user_idstring[]
company_idstring[]
segment_idstring
format'avro' | 'csv' | 'ndjson' | 'parquet'
exclusionsstring

Response

Created - Export job successfully created

environment_app_tokenstring

The app token of the environment.

environment_namestring

The name of the environment.

job_idstring

The ID of the export job.

linksstring

The links to the export job.

start_timestring

The start time of the export job.

Example response

{
  "environment_app_token": "NX-RE213S2",
  "environment_name": "production",
  "job_id": "123e4567-e89b-12d3-a456-426614174000"
}