GET/root/organizations/{organizationId}/data-usage
Get an organization's data usage
Operation root.organizations.dataUsage.get
Description
Returns an organization's stored document and blob bytes by category. Only root operators may call it, and each request is recorded in the root audit trail.
Authentication
Requires a signed-in session: the client sends its session token as a bearer token in the Authorization header.
Parameters
| Name | In | Type | Details |
|---|---|---|---|
organizationId | path | string | required
|
Responses
200 OK
application/jsonOrganizationDataUsageResponse
How much an organization stores, by documents and blobs.
4 fields
organizationIdstringrequired- not empty
blobsobjectrequired2 fields
blobCountintegerrequired- at least 0
byteLengthintegerrequired- at least 0
documentsobjectrequired4 fields
breakdownlist of objectrequired- exactly 4 items
4 fields
byteLengthintegerrequired- at least 0
categorystringrequired- one of
containerMetadata,rosterProfiles,organizationMetadata,user
- one of
documentCountintegerrequired- at least 0
updateCountintegerrequired- at least 0
byteLengthintegerrequired- at least 0
documentCountintegerrequired- at least 0
updateCountintegerrequired- at least 0
totalByteLengthintegerrequired- at least 0
Document plus blob bytes.
Other responses
| Status | Meaning | Body |
|---|---|---|
| 400 | Bad Request |
|
| 401 | Unauthorized |
|
| 403 | Forbidden |
|
| 404 | Not Found |
|
| 500 | Internal Server Error |
|
| 503 | Service Unavailable |
|
Additional rules
The server also enforces these rules, which the schema above cannot express.
totalByteLengthequals the sum of document and blob byte lengths.The document usage breakdown contains each document category exactly once.
Document usage totals equal the sums of the category breakdown.