Overview
Returns usage for the license period active at the time of the request. The organization is derived from the API key or OAuth session, so callers cannot request usage for another organization. License periods are administered by Narrative and are read-only to customers. The period uses a half-open range:starts_at is inclusive and ends_at is
exclusive. Each stream is assigned to the license period in which its task was
created.
License periods and allowances are configured independently for each
organization. They are not inherited from a parent organization, and usage
from related organizations is never included in this response.
licensed_hours and remaining_hours are null when the period has been
created but its contracted allowance has not yet been entered. The period is
still configured and used_hours continues to report its measured usage.
If no active license has been configured, the endpoint returns 200 with
configured: false, license_period: null, and remaining_hours: null.
used_hours, stream_count, and streams then report all-time usage for the
organization instead of a license-period total.
Query Parameters
Example Request
Example Response
Usage measurement
used_hours is the sum of hours_ingested for streams created during the
active license period. This is the same ingestion counter already maintained
for every processing task; there is no separate session ledger or second usage
counter. When configured is false, the same fields cover all streams from
the organization’s complete history.
Use stream_count, limit, and offset to page through the complete stream
breakdown. For a file containing every stream, use
Download Current Usage.