GET /v1/metrics/overview

Part of the API reference; this page is generated from the OpenAPI document that the gateway builds from its own route tables.

Provenance

• Contract version: 1.10.0
• Contract title: acumen gateway API
• Source: acumen:docs/openapi/acumen-v1.openapi.json

Operations

GET /v1/metrics/overview

Metrics overview for a window

Window headline: request totals and error taxonomy, latency percentiles over successful attempts, throughput, token totals (unpersisted fields null with a reason), the measured cost split (list, paid, plan-covered notional, free, unpriced), reliability counters and a coverage block. Operator (ops:read) scope.

• Operation id: getV1MetricsOverview
• Scope: ops:read
• Exposure: operator
• Mutating: no
• Auth: bearerAuth, operatorSession

Responses

• 200: OK
  • application/json: MetricsOverview: MetricsOverview (object)
• 400: schema_invalid — the request body or parameter failed validation
  • application/problem+json: Problem: Problem (object)
• 401: auth_missing — no virtual key or operator session
  • application/problem+json: Problem: Problem (object)
• 403: auth_scope — the credential lacks the route’s scope
  • application/problem+json: Problem: Problem (object)
• 404: resource_not_found — the addressed object does not exist
  • application/problem+json: Problem: Problem (object)
• 405: method_not_allowed — the path exists for another verb
  • application/problem+json: Problem: Problem (object)
• 429: rate_limited — the per-key or per-IP bucket is exhausted
  • application/problem+json: Problem: Problem (object)
• 500: internal — the store or process failed
  • application/problem+json: Problem: Problem (object)
• 501: not_implemented — the route is declared but not wired in this build
  • application/problem+json: Problem: Problem (object)
• 503: store_unavailable — the dependency is down; retryable
  • application/problem+json: Problem: Problem (object)