NAnace
operations

get_usage

Aggregate job units for a billing period. Cost class: fast.

credits is what the period bills; units are measured work, including failed and cancelled jobs that are not billed. The admission allowance also counts failed and cancelled work and in-flight reservations, so a quota_exceeded credits_used can exceed credits_total.

pages and bytes_ingested aggregate the per-job processing volume the workers record at completion time. credits sums only jobs whose usage is final; unfinalized_jobs counts the ones still open.

get/v1/usage

Request

Query parameters

period_startstring date required

Start of the billing window, inclusive.

period_endstring date required

End of the billing window, inclusive.

workspace_idstring uuid nullable

Restrict to one workspace. Omit to aggregate all jobs for this API key.

group_by'day' | 'kind' | 'workspace' | 'tenant'

Aggregation key: calendar day, job kind, or workspace. tenant is for a partner key sent without X-NDI-Tenant: one bucket per child tenant, keyed by its external_ref.

Response

Successful Response

credits_totalinteger required

Sum of credits across all buckets: final credits for the period.

group_bystring required
period_endstring date required
period_startstring date required
units_totalinteger required

Changes

No recorded changes to this operation across all 2 revisions of this API.