Page data usage by organization | API reference

Description

Pages stored data usage by organization, newest organizations first, with the same exact-id filter as the organization list. 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
`cursor`	query	string	optional not empty
`limit`	query	integer	optional 1 to 200
`search`	query	string	optional at most 200 characters

Responses

200 OK

application/jsonRootDataUsageReportResponse

A page of stored data usage by organization.

2 fields

organizationslist of objectrequired
2 fields
- organizationRootOrganizationSummaryResponserequired
- dataUsageOrganizationDataUsageResponserequired
Other fields are allowed.
nextCursorstringrequirednullable
Opaque cursor for the next page, or null at the end.

Other fields are allowed.

Other responses

Status	Meaning	Body
400	Bad Request	`application/json`ErrorResponse
401	Unauthorized	`application/json`SessionFailureResponse
403	Forbidden	`application/json`ErrorResponse
500	Internal Server Error	`application/json`ErrorResponse
503	Service Unavailable	`application/json`ErrorResponse

Additional rules

The server also enforces these rules, which the schema above cannot express.

totalByteLength equals 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.