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.

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

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

usageReportId*integer

Usage report ID

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

report*OrganizationUsageReport (object)

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "error": "text",
  "report": {
    "created": "2024-07-04T17:54:36.644Z",
    "createdByUser": {
      "name": "text",
      "username": "text",
      "photo": "text"
    },
    "jobFinished": false,
    "jobFinishedSuccessful": false,
    "downloadLink": "text",
    "reportStartDate": "2024-07-04T17:54:36.644Z",
    "reportEndDate": "2024-07-04T17:54:36.644Z"
  }
}