Skip to main content
POST
/
api
/
v1
/
analytics
/
export
Request export
curl --request POST \
  --url https://api.engagefabric.com/api/v1/analytics/export \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "dataType": "overview",
  "format": "csv",
  "startDate": "2025-01-01T00:00:00Z",
  "endDate": "2025-12-31T23:59:59Z"
}
'
{
  "exportId": "<string>",
  "status": "processing",
  "estimatedSeconds": 123
}

Body

application/json
​
projectId
string
required

Project ID to export data from

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
dataType
enum<string>
required

Type of data to export

Available options:
players,
events,
quests,
overview,
retention
Example:

"overview"

​
format
enum<string>
default:csv

Export format

Available options:
csv,
json
​
startDate
string

Start date for export range (ISO 8601)

Example:

"2025-01-01T00:00:00Z"

​
endDate
string

End date for export range (ISO 8601)

Example:

"2025-12-31T23:59:59Z"

Response

202 - application/json

Export job started

​
exportId
string
required

Export job ID

​
status
enum<string>
required

Current export status

Available options:
processing,
completed,
failed
​
estimatedSeconds
number
required

Estimated completion time in seconds