White Label Admin - Creates a new usage report

Create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response. This is an API only available to white label admins.

POSThttps://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

startDate*string (date-time)

Start date

endDate*string (date-time)

End date

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports?startDate=2024-11-21T10%3A45%3A38.702Z&endDate=2024-11-21T10%3A45%3A38.702Z', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "id": 12873488112
}