Skip to main content
POST
/
api
/
v1
/
analytics
/
exports
Trigger an Export Job
curl --request POST \
  --url https://appex.userpilot.io/api/v1/analytics/exports \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "<string>",
  "to": "<string>",
  "emails": [
    "<string>"
  ],
  "event_type": [
    "<string>"
  ],
  "user_id": [
    "<string>"
  ],
  "company_id": [
    "<string>"
  ],
  "segment_id": "<string>",
  "exclusions": "<string>"
}
'
{
  "environment_app_token": "NX-RE213S2",
  "environment_name": "production",
  "job_id": "123e4567-e89b-12d3-a456-426614174000",
  "links": "<string>",
  "start_time": "<string>"
}

Headers

ā€‹
Content-Type
string

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

ā€‹
Accept
string

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

ā€‹
Authorization
string
required

API authentication token in the format: Token {{API_KEY}}. Obtain your API key from the Userpilot Environment Settings.

Body

application/json
ā€‹
from
string
ā€‹
to
string
ā€‹
emails
string[]
ā€‹
event_type
string[]
ā€‹
user_id
string[]
ā€‹
company_id
string[]
ā€‹
segment_id
string
ā€‹
format
enum<string>
Available options:
avro,
csv,
ndjson,
parquet
ā€‹
exclusions
string

Response

Created - Export job successfully created

ā€‹
environment_app_token
string

The app token of the environment.

Example:

"NX-RE213S2"

ā€‹
environment_name
string

The name of the environment.

Example:

"production"

ā€‹
job_id
string

The ID of the export job.

Example:

"123e4567-e89b-12d3-a456-426614174000"

ā€‹
links
string

The links to the export job.

ā€‹
start_time
string

The start time of the export job.