Usage

Get usage snapshot

Changed on

Returns customer-facing usage metrics and costs for the requested period. Supports summary totals and daily buckets for timestamped usage sources. Vault storage is intentionally omitted from totals because it is not yet periodized for arbitrary windows.

get/usage/v1

Request

  • Base URL
    https://api.case.dev
  • URL
    https://api.case.dev/usage/v1
  • Auth
    HTTP bearer

Query parameters

periodStartstring date-time

Period start date. Defaults to the start of the current calendar month.

periodEndstring date-time

Period end date. Defaults to now.

granularity'summary' | 'daily'

Whether to return period totals only or include daily buckets.

lincSessionIdstring

Restrict usage to a native Linc session. The session must belong to the authenticated organization.

groupBy'lincSessionId'

Optionally include usage groups keyed by native Linc session id. Only Linc-session-attributable usage is grouped.

Response

Usage snapshot retrieved successfully

Changes

    • info

      added the new optional query request parameter groupBy

    • info

      added the new optional query request parameter lincSessionId

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      endpoint added