Usage Summary

Use this page to answer grouped questions such as “how much usage happened by customer, license, feature, or time bucket?”

Who This Is For

• operators reviewing metered usage totals
• developers building summarized usage dashboards
• teams preparing usage data for export or settlement review

When To Use This

Use usage summary when you want grouped totals rather than row-level events.

If you need row-level evidence, use Usage Ledger.

How It Works

GET /api/v1/reports/usage-summary uses report:read.

Important filters:

• from
• to
• group_by
• bucket with 1h or 1d
• product_id
• customer_id
• license_id
• order_id
• subscription_id
• feature_code

Response shape:

• data: one grouped summary object
• meta

Use the read API for live grouped analysis. Use exports when you need a frozen CSV, JSON, or PDF artifact.

Example

curl "https://api.licensekit.dev/api/v1/reports/usage-summary?group_by=customer_id&feature_code=api_calls&bucket=1d" \
  -H "Authorization: Bearer $LICENSEKIT_TOKEN"

Common Mistakes

• expecting row-level usage rows from the grouped summary endpoint
• using summary output as a substitute for the raw ledger when evidence detail matters
• omitting group_by and then expecting a pivoted result

Related Pages

• Usage Ledger
• Reporting Exports
• Metering