> ## Documentation Index
> Fetch the complete documentation index at: https://docs.keystoneos.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Get settlement throughput and funnel metrics

> Returns throughput statistics (finalized/rolled-back counts, average finalization time) and a funnel showing how many settlements entered each key state during the period.



## OpenAPI

````yaml https://api-staging.keystoneos.xyz/openapi.json get /v1/admin/settlements/metrics
openapi: 3.1.0
info:
  title: Keystone API
  description: Settlement orchestration API for tokenized Real-World Assets (RWAs).
  version: 0.1.0
servers:
  - url: https://api.keystoneos.xyz
    description: Production
security:
  - bearerAuth: []
tags:
  - name: health
    description: Health and version checks.
  - name: platforms
    description: Register and manage your platform profile.
  - name: environments
    description: Manage platform environments (sandbox, production).
  - name: settlement-templates
    description: View and manage settlement templates.
  - name: settlements
    description: Initiate, monitor, and manage settlements.
  - name: sessions
    description: Create and manage browser-safe session tokens for frontend widgets.
  - name: instructions
    description: Submit and manage bilateral settlement instructions.
  - name: invitations
    description: Invite team members to your platform.
  - name: members
    description: Manage platform team members and roles.
  - name: webhooks
    description: Configure webhook endpoints for real-time event notifications.
  - name: security
    description: IP allowlisting and API access controls.
  - name: activity
    description: Audit trail of platform actions.
  - name: dashboard
    description: Dashboard metrics and statistics.
  - name: callbacks
    description: Provider callback handlers (internal).
  - name: alchemy-webhooks
    description: Alchemy blockchain event webhooks (internal).
  - name: chains
    description: Supported blockchain networks for settlement.
  - name: admin
    description: KeyStone internal administration endpoints.
  - name: admin-platforms
    description: Admin platform management.
  - name: admin-settlements
    description: Admin settlement oversight and intervention.
  - name: admin-compliance
    description: Admin compliance check management.
  - name: admin-activity
    description: Admin system-wide activity logs.
  - name: admin-webhooks
    description: Admin webhook diagnostics.
  - name: internal
    description: Keystone-internal worker endpoints.
  - name: internal-compliance
    description: Internal compliance engine endpoints.
paths:
  /v1/admin/settlements/metrics:
    get:
      tags:
        - admin
        - admin-settlements
      summary: Get settlement throughput and funnel metrics
      description: >-
        Returns throughput statistics (finalized/rolled-back counts, average
        finalization time) and a funnel showing how many settlements entered
        each key state during the period.
      operationId: admin_metrics_v1_admin_settlements_metrics_get
      parameters:
        - name: environment_slug
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by environment slug (e.g., production, staging)
            title: Environment Slug
          description: Filter by environment slug (e.g., production, staging)
        - name: period
          in: query
          required: false
          schema:
            enum:
              - 1h
              - 24h
              - 7d
              - 30d
            type: string
            description: 'Time period: 1h, 24h, 7d, or 30d'
            default: 24h
            title: Period
          description: 'Time period: 1h, 24h, 7d, or 30d'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementMetrics'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SettlementMetrics:
      properties:
        period:
          type: string
          title: Period
        throughput:
          $ref: '#/components/schemas/MetricsThroughput'
        funnel:
          $ref: '#/components/schemas/MetricsFunnel'
      type: object
      required:
        - period
        - throughput
        - funnel
      title: SettlementMetrics
      description: Throughput and funnel statistics for a given time period.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MetricsThroughput:
      properties:
        finalized_count:
          type: integer
          title: Finalized Count
        rolled_back_count:
          type: integer
          title: Rolled Back Count
        average_time_to_finalize_seconds:
          anyOf:
            - type: number
            - type: 'null'
          title: Average Time To Finalize Seconds
          description: >-
            Average seconds from INSTRUCTED to FINALIZED. None if no finalized
            settlements in period.
      type: object
      required:
        - finalized_count
        - rolled_back_count
      title: MetricsThroughput
      description: Throughput statistics for the given period.
    MetricsFunnel:
      properties:
        instructed:
          type: integer
          title: Instructed
          default: 0
        compliance_cleared:
          type: integer
          title: Compliance Cleared
          default: 0
        assets_locked:
          type: integer
          title: Assets Locked
          default: 0
        finalized:
          type: integer
          title: Finalized
          default: 0
        rolled_back:
          type: integer
          title: Rolled Back
          default: 0
        timed_out:
          type: integer
          title: Timed Out
          default: 0
      type: object
      title: MetricsFunnel
      description: >-
        Funnel counts - how many settlements entered each state during the
        period.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Auth0 JWT access token. See
        [Authentication](/getting-started/authentication) for details.

````