Review and export usage
Read the billable operations the licence server recorded for your tenant, take a range out as a CSV file, and issue a signed monthly usage statement.
Who can do it
A tenant administrator. Every built-in tenant role can read the usage figures, but only the tenant administrator holds the permissions to export them and to issue statements. The console offers Export CSV only to a person who holds the export permission. The tenant is always your own: it is taken from your credential, and no screen or request names another one.
Before you start
- A deployment licence is in effect. Without one, every usage request is refused.
- Know which range you need. By day a range spans at most 366 days; by month, at most 24 months.
Steps
- Open Usage from your tenant's navigation. It opens on the last 30 days, by day.
- Choose the range:
- Select Last 7 days, Last 30 days, This month, Last month or Last 12 months; each reads its range at once.
- Or set From and To (inclusive UTC days) and select Apply.
- Choose the grain: Day or Month.
- When the range holds more periods than one page, move through them with Earlier periods and Later periods.
- Read each period's state before trusting its figures: an open period may still grow, a provisional one has ended but may still grow, and a final one will not change.
- To take the range out, select Export CSV. The export covers the whole applied range and grain, not only the page on screen, and the console waits up to two minutes for the file.
Listing earlier exports and the signed monthly usage statements are not offered in the console; use the API below.
What you see when it worked
The table shows one row per period with its state and its total, streaming and non-streaming operations, and the line under the controls names the range the figures belong to. After Export CSV, the browser downloads the file, and the export is recorded in the audit trail with its range and grain.
An issued statement is returned with its identity and signature; it is never rewritten, and a correction is a second statement that names the one it supersedes.
If it fails
| What you see | Cause | What to do |
|---|---|---|
| This range cannot be applied | Both ends are not set, the start is after the end, or the range is wider than the grain allows | Correct the dates, or read the range by month |
| The usage figures could not be read | The licence server did not return the figures. This is not a report of zero usage | Retry; if it persists, your platform operator checks the licence server |
| Too many usage exports are already in progress for you or your tenant, so this one was not started. | The per-person or per-tenant limit of running exports is reached | Wait for one to finish, then export again |
| The file was still being prepared after two minutes, so the console stopped waiting. | The export is still running on the server | Export again once it has ended |
| The server could not produce the file. | The export failed on the server | Export again; if it fails again, contact your platform operator |
| A statement is refused with a conflict | The month cannot be stated yet, it is already stated and the request declares no correction, or the statement named in supersedes is already superseded | Wait for the month to end, or correct the statement the error names as the current one |
| Access restricted | You lack the permission to read your tenant's usage | Ask a tenant administrator for it |
Without the console
| Surface | How |
|---|---|
| API: read | GET /api/v3/admin/usage/telemetry?from=<day>&to=<day>&grain=<grain>, the grain being day or month (operation getUsageTelemetry) |
| API: export | POST /api/v3/admin/usage/exports with from, to and grain (operation createUsageExport), then GET /api/v3/admin/usage/exports/{jobId} (getUsageExport) and GET /api/v3/admin/usage/exports/{jobId}/artifact (getUsageExportArtifact), each with the X-Usage-Export-Handle header the start returned; GET /api/v3/admin/usage/exports lists your tenant's exports (listUsageExports) |
| API: statements | POST /api/v3/admin/usage/statements with period (for example 2026-08) and, for a correction, supersedes (operation issueUsageStatement); GET /api/v3/admin/usage/statements (listUsageStatements); GET /api/v3/admin/usage/statements/{statementId} (getUsageStatement); GET /api/v3/admin/usage/statements/verification-keys (getUsageStatementVerificationKeys) to verify a statement's signature |
Related
- Usage: what the screen shows and every decision you make on it.