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

includeDeletedboolean

Whether to include deleted entities (users, projects, orgs)

Response

Body

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 CPU + GPU minutes.

billableboolean

entitlementLimitsEntitlementLimits (object)

totalStoragenumber

Storage entitlement, in bytes

computeTimePerYearnumber

Total compute time entitlement (CPU + GPU), in seconds

gpuComputeTimePerYearnumber

GPU compute time entitlement, in seconds

numberOfProjectsinteger

Number of projects allowed for this organization

numberOfUsersinteger

Number of users allowed for this organization

computeTimeCurrentContractSincestring (date-time)

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

totalStoragenumber

Total storage used by the organization.

dailyMetricsnullable array of DailyMetricsRecord (object)

Metrics for the last 365 days

date*string (date-time)

Date of the metrics record.

Example: "2021-01-01T00:00:00Z"

totalUsers*integer

Total number of users, if the metrics record applies to a non-developer profile organization. For developer profile organizations, we default to 0.

Example: 100

totalStaffUsers*integer

Total number of staff users, if the metrics record applies to a non-developer profile organization. For developer profile organizations, we default to 0.

Example: 10

totalProjects*integer

Total number of projects at the end of the metrics record date.

Example: 50

totalCurrentContractCpuComputeTimeSeconds*integer

Total CPU compute time since contract start date, or organization / user creation date, at the end of the metrics record date.

Example: 100000

totalCurrentContractGpuComputeTimeSeconds*integer

Total GPU compute time since contract start date, or organization / user creation date, at the end of the metrics record date.

Example: 100000

totalCurrentContractComputeTimeSeconds*integer

Total compute time since contract start date, or organization / user creation date, at the end of the metrics record date. Compute time is calculated as CPU + 3*GPU compute time.

Example: 100000

computeTimeCalculatedSince*string (date-time)

Date from which the total compute time is calculated. This is the contract start date for billing organizations, or organization / user creation date.

Example: "2021-01-01T00:00:00Z"

totalStorageSizeBytes*integer

Total storage size in bytes at the end of the metrics record date.

Example: 1000000000

usersAdded*integer

Number of users added during the metrics record date.

Example: 10

staffUsersAddedinteger

Number of staff users added during the metrics record date.

Example: 1

usersDeleted*integer

Number of users deleted during the metrics record date.

Example: 5

staffUsersDeletedinteger

Number of staff users deleted during the metrics record date.

Example: 1

projectsAdded*integer

Number of projects added during the metrics record date.

Example: 10

projectsDeleted*integer

Number of projects deleted during the metrics record date.

Example: 5

cpuComputeTimeSeconds*integer

Total CPU compute time during the metrics record date.

Example: 10000

gpuComputeTimeSeconds*integer

Total GPU compute time during the metrics record date.

Example: 10000

computeTimeSeconds*integer

Total compute time during the metrics record date. Compute time is calculated as CPU + 3*GPU compute time.

Example: 10000

storageBytesAdded*integer

Total storage size in bytes added during the metrics record date.

Example: 1000000000

storageBytesDeleted*integer

Total storage size in bytes deleted during the metrics record date.

Example: 500000000

Request

Response