AFaffinda
Usage

Get usage

Changed on

Returns daily credits consumption for an organization over a date range. Optionally scope the report to a single workspace, a single document type, or a single (workspace × document type) pair by supplying both workspace and document_type.

get/v3/usage

Request

Query parameters

organizationstring required

Uniquely identify an organization.

Example:mEFayXdO

Organization to report usage for. The caller must be an admin or owner.

workspacestring

Uniquely identify a workspace.

Example:mEFayXdO

Optionally scope the report to a single workspace within the organization. Combine with document_type to scope to a single (workspace × document type) pair.

document_typestring

Uniquely identify a collection.

Example:mEFayXdO

Optionally scope the report to a single document type within the organization. Combine with workspace to scope to a single (workspace × document type) pair.

startstring date

Inclusive start date of the report (YYYY-MM-DD). Defaults to 365 days before end.

endstring date

Inclusive end date of the report (YYYY-MM-DD). Defaults to today.

Response

Daily credits consumption for the requested scope.

scope'organization' | 'workspace' | 'documentType' | 'workspaceAndDocumentType' required

What the usage was scoped to.

scopeIdentifierstring required

Identifier of the scoped entity: the organization, workspace, or document type identifier. When scoped to a (workspace × document type) pair, it is the workspace and document type identifiers joined by a colon ({workspaceIdentifier}:{documentTypeIdentifier}).

startstring date required

Inclusive start of the reported period (YYYY-MM-DD).

endstring date required

Inclusive end of the reported period (YYYY-MM-DD).

totalinteger required

Total credits consumed over the period.

Example response

{
  "start": "2025-04-01",
  "end": "2025-04-30",
  "total": 4320,
  "items": [
    {
      "date": "2025-04-15",
      "count": 123
    }
  ]
}

Changes