Report Kinds

Use this page to map report-kind identifiers to the reporting reads and export flows that use them.

Who This Is For

• developers creating report exports
• SDK maintainers exposing report-kind enums
• operators deciding which reporting artifact to request

When To Use This

Read this page when you need the canonical report_kind identifiers used by the export API.

How It Works

Current report kinds:

• usage-summary
• usage-ledger
• license-audit
• customer-summary
• subscription-settlement

These values appear in:

• POST /api/v1/reports/exports
• export metadata
• SDK enums and generated types

Example

Mapping:

Report kind	Read API	Typical question
usage-summary	GET /api/v1/reports/usage-summary	how much usage happened by group
usage-ledger	GET /api/v1/reports/usage-ledger	which usage rows were recorded
license-audit	GET /api/v1/reports/license-audit	what happened for one license
customer-summary	GET /api/v1/reports/customer-summary	what is happening for one customer
subscription-settlement	GET /api/v1/reports/subscription-settlement	what is the settlement-oriented summary for a subscription or order

Minimal export request:

{
  "report_kind": "usage-summary",
  "format": "csv"
}

Common Mistakes

• sending a human title instead of the canonical report_kind
• confusing read endpoints with export identifiers
• assuming PDF support exists for a report kind without checking current renderer support

Related Pages

• Reporting Overview
• Reporting Exports
• PDF Exports