Tenant usage

GET/v1/tenants/{tenantId}/usagev3.0.0-next.9

Per-tenant usage facts (views, uploads, stored bytes) for one UTC month.

Facts only — no limits or billing state. Views count share exchanges plus authorized /v1/access grants, deduplicated across the two.

Authentication#

Any one of these credentials is accepted.

API token

The deployment's static root credential (CLOUDPDF_API_AUTH_TOKENS), valid on every surface.

Tenant token

Delegated tenant JWT, valid only under its own /v1/tenants/{tenantId}/ subtree — the path tenant must equal the token's tenant_id. Doc-scoped viewer tokens are rejected on every admin route.

Required scopedocs.read

Parameters#

tenantIdpathstringrequired

periodquerystring

SDK examples#

The selected SDK is remembered across the API reference. Values are examples; replace them with identifiers and input from your application.

import { CloudPDFClient } from "@cloudpdf/sdk";

const client = new CloudPDFClient({
  baseUrl: "https://yourhost.com/path/to/api",
  token: "<token>",
});

await client.tenants.usage({
  tenantId: "tenantId"
});

Responses#

200OK

application/jsonTenantsUsage200Response

tenantIdstring

periodStartstring

periodEndstring

metricsobject

pdf.viewsnumber

pdf.uploadsnumber

storage.bytesnumber

400Bad request

application/jsonTenantsUsage400Response

errorobject

codestring

messagestring

404Not found

application/jsonTenantsUsage404Response

errorobject

codestring

messagestring

defaultError

application/jsonAdminErrorPayload

errorobject

codestring

messagestring