White Label Admin - Get usage report

White Label Admin - Get usage report

Get a usage report for an organization. This is an API only available to white label admins.

get

/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

innerOrganizationIdintegerrequired

Organization ID within the context of a white label

reportIdintegerrequired

Report ID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}' \
  --header 'x-api-key: YOUR_API_KEY'

200

200

{
  "success": true,
  "error": "text",
  "report": {
    "id": 1,
    "created": "2025-02-21T18:02:10.492Z",
    "createdByUser": {
      "id": 1,
      "name": "text",
      "username": "text",
      "photo": "text"
    },
    "jobId": 1,
    "jobFinished": true,
    "jobFinishedSuccessful": true,
    "downloadLink": "text",
    "reportStartDate": "2025-02-21T18:02:10.492Z",
    "reportEndDate": "2025-02-21T18:02:10.492Z"
  }
}

OK