White Label Admin - Get all usage reports

White Label Admin - Get all usage reports

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

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Query parameters

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

reports*array of Report (object)

List of organization usage reports.

totalCount*integer

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text",
  "reports": [
    {
      "id": 0,
      "created": "2024-12-21T12:30:43.311Z",
      "createdByUser": {
        "id": 0,
        "name": "text",
        "username": "text",
        "photo": "text"
      },
      "jobId": 0,
      "jobFinished": false,
      "jobFinishedSuccessful": false,
      "downloadLink": "text",
      "reportStartDate": "2024-12-21T12:30:43.311Z",
      "reportEndDate": "2024-12-21T12:30:43.311Z"
    }
  ],
  "totalCount": 0
}