Sign in

v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB
Exports

Get an export using the ID

get/environments/{environmentId}/exports/{exportId}

Path parameters

environmentIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the environment

exportIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the export

Response

Successfully retrieved an export and its current state

idstring required
format'csv' required
model'users' | 'visits' required
status'completed' | 'failed' | 'pending' required
createdAtstring date-time required
startedAtstring date-time nullable
completedAtstring date-time nullable
downloadUrlstring url
errorstring

When defined, this is the error message and stack trace received when attempting to process the export.

Example response

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f"
}