Skip to content
Version: Current

GET /v1/metrics/plans

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

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

Provider and account plan classification

The whole estate classified per provider and account: classification and its basis, plan and tier labels, plan-covered and tool-allowance flags, measured allowances with reset instants, live offer counts by class, and the tier table. Reports the catalogue even with no traffic, so no data is visible as its own fact. Operator (ops:read) scope.

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

Responses

  • 200: OK
    • application/json: MetricsPlans: MetricsPlans (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)