Get the exports for an environment

GET /environments/{environmentId}/exports

Try it

Get the exports for an environment

cURL

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/exports \
  --header 'Authorization: Bearer <token>'

200

{
  "exports": [
    {
      "id": "95b11417-f18f-457f-8804-68e361f9164f",
      "format": "csv",
      "model": "users",
      "status": "completed",
      "createdAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "downloadUrl": "<string>",
      "error": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Query Parameters

model · enum<string>

The type of data to export

Available options: users, visits

Response

200

application/json

List of exports for this project environment

exports · object[]

Show child attributes

exports. id · string · required

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

exports. format · enum<string> · required

Available options: csv

exports. model · enum<string> · required

Available options: users, visits

exports. status · enum<string> · required

Available options: completed, failed, pending

exports. createdAt · string<date-time> · required

exports. startedAt · string<date-time> | null

exports. completedAt · string<date-time> | null

exports. downloadUrl · string<url>

exports. error · string

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