On this page

Trigger Bulk Export Job
Request
Body Parameters
Response
Example Response

Trigger Bulk Export Job

Endpoint: POST /api/v1/analytics/exports/ This endpoint allows you to request a bulk export of users, companies, or events.

Request

Content-Type: application/json
Authorization: Token <apiKey> (optional)

Body Parameters

Name	Type	Description
from	string	Start date (ISO 8601)
to	string	End date (ISO 8601)
emails	array	List of emails to notify
event_type	array	Event types to export
user_id	array	User IDs to export
company_id	array	Company IDs to export
segment_id	string	Segment ID to export
format	string	Export file format
exclusions	string	Exclusions for export

Response

201 Created: Export job successfully created
401 Unauthorized: Invalid API key or insufficient permissions
409 Conflict: Export job already in progress

Example Response

{
  "job_id": "export:jobs:xyz789",
  "status": "pending",
  "start_time": "2024-06-01T12:00:00Z"
}