Skip to main content
GET
Get Usage Breakdown

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

Query Parameters

billing_month
string | null

Billing month in YYYY-MM format (defaults to current month)

Example:

"2025-12"

Response

Successful Response

Response with detailed usage breakdown.

billing_month
string
required

Billing month (YYYY-MM)

Example:

"2025-12"

total_credits
integer
required

Total credits consumed

Example:

23450

total_cost_usd
number
required

Total cost in USD

Example:

23.45

by_operation
By Operation · object
required

Credits consumed by operation type

Example:
by_extractor
By Extractor · object
required

Credits consumed by extractor

Example:
period_start
string<date-time>
required

Start of billing period

period_end
string<date-time>
required

End of billing period

by_namespace
By Namespace · object

Credits consumed by namespace (chargeback / cost-allocation for multi-namespace orgs). Keyed by namespace_id; excludes namespace-less consumption. Empty for older usage recorded before per-namespace attribution.

Example:
by_retriever
By Retriever · object

Credits consumed by retriever (per-product query-cost attribution for chargeback). Keyed by retriever_id (resource_type='retriever' charges: queries, enrichment). Empty when no retriever-attributed usage.

Example:
by_resource_kind
By Resource Kind · object

Credits consumed by the kind of resource charged: extractor_run, retriever, mvs, upload, storage, inference or other. Read from the daily per-resource cost rollup, so it covers the days that rollup has run; empty when it has no rows for the month.

Example:
by_storage_class
By Storage Class · object

Average stored data per storage class over the billing month, in GB-months (each day's GB summed, divided by the days in the month). Keyed by the bucket's class name, lowercased (standard, nearline, coldline, archive on GCS; standard, standard_ia, glacier and so on on S3). Empty when no storage was measured for the month.

Example:
pending_credits
number
default:0

Unflushed sub-credit usage accrued but not yet committed to by_operation. Micro-priced per-op usage (e.g. MVS writes/queries at ~0.001 credit each) accumulates here and rolls into by_operation in whole credits as it crosses 1 — so real activity is visible immediately, before a whole credit accrues.

Example:

0.014

pending_by_operation
Pending By Operation · object

Unflushed fractional credits by operation type.

Example: