{
  "version": 1,
  "generated_at": "2026-04-16",
  "generated_from": [
    "api/openapi.yaml",
    "internal/db/reporting_exports.go",
    "internal/db/reporting_export_pdf.typ"
  ],
  "export_scope": "report:export",
  "supported_export_formats": [
    "json",
    "csv",
    "pdf"
  ],
  "export_operations": {
    "create": "createReportExport",
    "get": "getReportExport",
    "download": "downloadReportExport"
  },
  "report_kinds": [
    {
      "id": "usage-summary",
      "question": "Grouped usage totals over a time window.",
      "read_operation_id": "getUsageSummary",
      "read_path": "/api/v1/reports/usage-summary",
      "read_scope": "report:read",
      "read_summary": "Get grouped usage totals",
      "supported_export_formats": [
        "json",
        "csv",
        "pdf"
      ],
      "required_filters": [],
      "at_least_one_of_filters": [],
      "optional_filters": [
        "limit",
        "from",
        "to",
        "group_by",
        "bucket",
        "product_id",
        "customer_id",
        "license_id",
        "order_id",
        "subscription_id",
        "feature_code"
      ]
    },
    {
      "id": "usage-ledger",
      "question": "Row-level usage ledger entries and consumption evidence.",
      "read_operation_id": "listUsageLedger",
      "read_path": "/api/v1/reports/usage-ledger",
      "read_scope": "report:read",
      "read_summary": "List row-level usage ledger entries",
      "supported_export_formats": [
        "json",
        "csv",
        "pdf"
      ],
      "required_filters": [],
      "at_least_one_of_filters": [],
      "optional_filters": [
        "cursor",
        "limit",
        "from",
        "to",
        "action",
        "product_id",
        "customer_id",
        "license_id",
        "order_id",
        "subscription_id",
        "feature_code"
      ]
    },
    {
      "id": "license-audit",
      "question": "Activity, usage, events, and device state for one license.",
      "read_operation_id": "getLicenseAuditReport",
      "read_path": "/api/v1/reports/license-audit",
      "read_scope": "report:read",
      "read_summary": "Get a license audit report",
      "supported_export_formats": [
        "json",
        "csv",
        "pdf"
      ],
      "required_filters": [
        "license_id"
      ],
      "at_least_one_of_filters": [],
      "optional_filters": [
        "limit",
        "from",
        "to"
      ]
    },
    {
      "id": "customer-summary",
      "question": "Licenses, usage, orders, and subscriptions for one customer.",
      "read_operation_id": "getCustomerSummary",
      "read_path": "/api/v1/reports/customer-summary",
      "read_scope": "report:read",
      "read_summary": "Get customer-level reporting summary",
      "supported_export_formats": [
        "json",
        "csv",
        "pdf"
      ],
      "required_filters": [
        "customer_id"
      ],
      "at_least_one_of_filters": [],
      "optional_filters": [
        "limit",
        "from",
        "to"
      ]
    },
    {
      "id": "subscription-settlement",
      "question": "Settlement-oriented summary for one subscription or order.",
      "read_operation_id": "getSubscriptionSettlement",
      "read_path": "/api/v1/reports/subscription-settlement",
      "read_scope": "report:read",
      "read_summary": "Get subscription or order settlement summary",
      "supported_export_formats": [
        "json",
        "csv",
        "pdf"
      ],
      "required_filters": [],
      "at_least_one_of_filters": [
        [
          "subscription_id",
          "order_id"
        ]
      ],
      "optional_filters": [
        "limit",
        "from",
        "to",
        "group_by"
      ]
    }
  ]
}