Inspect operational usage of Provider-owned configurations
Generated from the checked-in source. Do not edit this reference by hand.
GET /api/v1/providers/{provider}/configuration-usage
Installation credential or explicit platform administrator required. Provider membership and customer roles do not grant access. Uses current explicit configuration ownership and persisted managed/media request routes; includes disabled configurations and does not infer unbound legacy/static traffic. This is current-configuration operational history, not historical financial attribution, qualified commercial supply, earnings or settlement. Counts each dispatched attempt once, including retry attempts. From is inclusive, to exclusive, in epoch milliseconds; maximum range 90 days. Token sums include only complete provider-reported aggregate token usage; unknown requests and non-token media remain separately counted. Failures count persisted safe failure observations, not an inference that every unsuccessful request has one. Timing counts refer to recorded HTTP delivery, not video job completion. Totals cover the whole range regardless of model page. after is an exclusive lexical model-alias boundary, not an identity lookup; pages are live statement snapshots. No customer identity, request/key IDs, endpoint, credentials, costs or prices are returned. No upstream call or mutation. Cache-Control no-store.
Operation: getProviderConfigurationUsage.
Authentication
Section titled “Authentication”Use the credential and permission scope described above. Each object below is an alternative; schemes within one object are required together.
[ { "bearerAuth": [] }]HTTP request
Section titled “HTTP request”Set NIU_ORIGIN to your installation origin (without /v1). Replace path, query and header placeholders with the required values. Query examples use curl 7.87 or newer to encode values with --url-query. Use the credential scope described above; a bearer token must have the authority required by this operation.
curl --fail-with-body -X GET "$NIU_ORIGIN/api/v1/providers/{provider}/configuration-usage" \ -H "Authorization: Bearer $NIU_BEARER_TOKEN" \ --url-query 'from_ms=<FROM_MS>' \ --url-query 'to_ms=<TO_MS>'Parameters
Section titled “Parameters”provider
Section titled “provider”Location: path. Required.
{ "type": "string", "format": "uuid"}from_ms
Section titled “from_ms”Location: query. Required.
{ "type": "integer", "minimum": 0, "maximum": 253402300799999}Location: query. Required.
{ "type": "integer", "minimum": 1, "maximum": 253402300799999}Location: query. Optional.
{ "type": "string", "minLength": 1, "maxLength": 256}Location: query. Optional.
{ "type": "integer", "minimum": 1, "maximum": 100, "default": 50}Request body
Section titled “Request body”No request body is declared.
Responses
Section titled “Responses”HTTP 200
Section titled “HTTP 200”Scoped operational counts; not supply or financial qualification.
Content type: application/json.
{ "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "from_ms", "to_ms", "observed_at", "totals", "models", "next_after" ], "properties": { "from_ms": { "type": "integer" }, "to_ms": { "type": "integer" }, "observed_at": { "type": "string", "format": "date-time" }, "totals": { "type": "object", "additionalProperties": false, "required": [ "requests", "completed", "execution_unknown", "known_token_usage_requests", "unknown_token_usage_requests", "prompt_tokens", "completion_tokens", "failures", "observed_timing_requests", "complete_timing_requests", "complete_total_ms" ], "properties": { "requests": { "type": "string", "pattern": "^[0-9]+$" }, "completed": { "type": "string", "pattern": "^[0-9]+$" }, "execution_unknown": { "type": "string", "pattern": "^[0-9]+$" }, "known_token_usage_requests": { "type": "string", "pattern": "^[0-9]+$" }, "unknown_token_usage_requests": { "type": "string", "pattern": "^[0-9]+$" }, "prompt_tokens": { "type": "string", "pattern": "^[0-9]+$" }, "completion_tokens": { "type": "string", "pattern": "^[0-9]+$" }, "failures": { "type": "string", "pattern": "^[0-9]+$" }, "observed_timing_requests": { "type": "string", "pattern": "^[0-9]+$" }, "complete_timing_requests": { "type": "string", "pattern": "^[0-9]+$" }, "complete_total_ms": { "type": [ "string", "null" ], "pattern": "^[0-9]+$", "description": "Sum of complete observed HTTP delivery durations; null without any complete timing. Not asynchronous job duration." } } }, "models": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "requests", "completed", "execution_unknown", "known_token_usage_requests", "unknown_token_usage_requests", "prompt_tokens", "completion_tokens", "failures", "observed_timing_requests", "complete_timing_requests", "complete_total_ms", "model" ], "properties": { "requests": { "type": "string", "pattern": "^[0-9]+$" }, "completed": { "type": "string", "pattern": "^[0-9]+$" }, "execution_unknown": { "type": "string", "pattern": "^[0-9]+$" }, "known_token_usage_requests": { "type": "string", "pattern": "^[0-9]+$" }, "unknown_token_usage_requests": { "type": "string", "pattern": "^[0-9]+$" }, "prompt_tokens": { "type": "string", "pattern": "^[0-9]+$" }, "completion_tokens": { "type": "string", "pattern": "^[0-9]+$" }, "failures": { "type": "string", "pattern": "^[0-9]+$" }, "observed_timing_requests": { "type": "string", "pattern": "^[0-9]+$" }, "complete_timing_requests": { "type": "string", "pattern": "^[0-9]+$" }, "complete_total_ms": { "type": [ "string", "null" ], "pattern": "^[0-9]+$", "description": "Sum of complete observed HTTP delivery durations; null without any complete timing. Not asynchronous job duration." }, "model": { "type": "string" } } } }, "next_after": { "type": [ "string", "null" ] } } } }, "additionalProperties": false}HTTP 400
Section titled “HTTP 400”Invalid interval, cursor boundary, limit or query.
HTTP 401
Section titled “HTTP 401”Authentication required.
HTTP 403
Section titled “HTTP 403”Platform administration required.
HTTP 404
Section titled “HTTP 404”Provider does not exist or is deleted.
HTTP 503
Section titled “HTTP 503”Storage unavailable or diagnostic query deadline exceeded; no partial totals.
Behavior and supported scope
Section titled “Behavior and supported scope”Installation credential or explicit platform administrator required. Provider membership and customer roles do not grant access. Uses current explicit configuration ownership and persisted managed/media request routes; includes disabled configurations and does not infer unbound legacy/static traffic. This is current-configuration operational history, not historical financial attribution, qualified commercial supply, earnings or settlement. Counts each dispatched attempt once, including retry attempts. From is inclusive, to exclusive, in epoch milliseconds; maximum range 90 days. Token sums include only complete provider-reported aggregate token usage; unknown requests and non-token media remain separately counted. Failures count persisted safe failure observations, not an inference that every unsuccessful request has one. Timing counts refer to recorded HTTP delivery, not video job completion. Totals cover the whole range regardless of model page. after is an exclusive lexical model-alias boundary, not an identity lookup; pages are live statement snapshots. No customer identity, request/key IDs, endpoint, credentials, costs or prices are returned. No upstream call or mutation. Cache-Control no-store.
Supported scope: implemented