White Label Admin - Get organization data export

Get a data export for an organization. This is an API only available to white label admins.

GET /api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}

Try it

White Label Admin - Get organization data export

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId} \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "export": {
    "id": 123,
    "created": "2023-11-07T05:31:56Z",
    "jobId": 123,
    "jobFinished": true,
    "jobFinishedSuccessful": true,
    "expirationDate": "2023-11-07T05:31:56Z",
    "createdByUser": {
      "id": 123,
      "name": "<string>",
      "username": "<string>",
      "photo": "<string>"
    },
    "description": "<string>",
    "downloadUrl": "<string>"
  },
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

innerOrganizationId · integer · required

Organization ID within the context of a white label

exportId · integer · required

Export ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

export · object · required

Show child attributes

export. id · integer · required

export. created · string<date-time> · required

export. jobId · integer · required

export. jobFinished · boolean · required

export. jobFinishedSuccessful · boolean · required

export. expirationDate · string<date-time> · required

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

export. createdByUser · object

Show child attributes

export.createdByUser. id · integer · required

export.createdByUser. name · string · required

export.createdByUser. username · string · required

export.createdByUser. photo · string

export. description · string

Description of the data export

export. downloadUrl · string

error · string

Optional error description (set if 'success' was false)