White Label Admin - Get all usage reports

PreviousWhite Label Admin - Get organization compute time usage NextWhite Label Admin - Creates a new usage report

Last updated 10 months ago

Was this helpful?

White Label Admin - Get all usage reports

Get all usage reports for an organization. This is an API only available to white label admins.

get

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

Authorizations

Path parameters

organizationIdintegerrequired

Organization ID

innerOrganizationIdintegerrequired

Organization ID within the context of a white label

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "success": true,
  "error": "text",
  "totalCount": 1,
  "reports": [
    {
      "id": 1,
      "created": "2025-02-21T18:08:48.115Z",
      "createdByUser": {
        "id": 1,
        "name": "text",
        "username": "text",
        "photo": "text"
      },
      "jobId": 1,
      "jobFinished": true,
      "jobFinishedSuccessful": true,
      "downloadLink": "text",
      "reportStartDate": "2025-02-21T18:08:48.115Z",
      "reportEndDate": "2025-02-21T18:08:48.115Z"
    }
  ]
}