White Label Admin - Get organization information

White Label Admin - Get organization information

White label admin only API to list all information about an organization.

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

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)

cpuComputeTimenumber

CPU compute time in seconds of all jobs in the organization (including organizational project jobs).

gpuComputeTimenumber

GPU compute time in seconds of all jobs in the organization (including organizational project jobs).

totalComputeTimenumber

Total compute time is the amount of computation time spent in jobs, in minutes used by an organization over the given period, calculated as 1 x CPU + 3 x GPU minutes.

billableboolean

entitlementLimitsEntitlementLimits (object)

computeTimeCurrentContractSincestring (date-time)

The date from which the compute time for the running contract is calculated.

totalStoragenumber

Total storage used by the organization.

dailyMetricsarray of DailyMetricsRecord (object)

Metrics for the last 365 days

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "error": "text",
  "cpuComputeTime": 0,
  "gpuComputeTime": 0,
  "totalComputeTime": 0,
  "billable": false,
  "entitlementLimits": {
    "totalStorage": 0,
    "computeTimePerYear": 0,
    "gpuComputeTimePerYear": 0
  },
  "computeTimeCurrentContractSince": "2024-07-04T17:57:40.465Z",
  "totalStorage": 0,
  "dailyMetrics": [
    {
      "date": "2021-01-01T00:00:00Z",
      "totalUsers": 100,
      "totalStaffUsers": 10,
      "totalProjects": 50,
      "totalCurrentContractCpuComputeTimeSeconds": 100000,
      "totalCurrentContractGpuComputeTimeSeconds": 100000,
      "totalCurrentContractComputeTimeSeconds": 100000,
      "computeTimeCalculatedSince": "2021-01-01T00:00:00Z",
      "totalStorageSizeBytes": 1000000000,
      "usersAdded": 10,
      "staffUsersAdded": 1,
      "usersDeleted": 5,
      "staffUsersDeleted": 1,
      "projectsAdded": 10,
      "projectsDeleted": 5,
      "cpuComputeTimeSeconds": 10000,
      "gpuComputeTimeSeconds": 10000,
      "computeTimeSeconds": 10000,
      "storageBytesAdded": 1000000000,
      "storageBytesDeleted": 500000000
    }
  ]
}