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

# Get User Metrics Summary

> Retrieve a summary of the authenticated user's core usage metrics, including unique agents used, lifetime completion calls, successful completions, and recent-window completion counts.



## OpenAPI

````yaml https://api.swarms.world/openapi.json get /v1/account/metrics/summary
openapi: 3.1.0
info:
  title: Swarms API
  description: >-
    Swarms API provides scalable, secure orchestration for multi-agent systems.
    Access robust endpoints for managing agents and swarms, automating
    workflows, and monitoring execution. Requires an API key—see the [API Keys
    page](https://swarms.world/platform/api-keys). Refer to [Swarms API
    Documentation](https://docs.swarms.ai) for guides and details.
  version: 1.0.0
servers:
  - url: https://api.swarms.world
    description: Swarms Production API
security: []
paths:
  /v1/account/metrics/summary:
    get:
      tags:
        - Account Management
        - Metrics
        - Monitoring
      summary: Get User Metrics Summary
      description: >-
        Retrieve a summary of the authenticated user's core usage metrics,
        including unique agents used, lifetime completion calls, successful
        completions, and recent-window completion counts.
      operationId: get_metrics_summary_v1_account_metrics_summary_get
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsSummaryOutput'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    MetricsSummaryOutput:
      properties:
        success:
          type: boolean
          title: Success
          description: Indicates whether the metrics summary was retrieved successfully.
          default: true
        unique_agents:
          type: integer
          title: Unique Agents
          description: Number of unique agent configurations the user has used.
        total_completion_calls:
          type: integer
          title: Total Completion Calls
          description: Lifetime count of completion calls.
        successful_completions:
          type: integer
          title: Successful Completions
          description: Lifetime count of completions with status 'success'.
        completions_last_24h:
          type: integer
          title: Completions Last 24H
          description: Completion calls in the last 24 hours.
        completions_last_7d:
          type: integer
          title: Completions Last 7D
          description: Completion calls in the last 7 days.
        timestamp:
          type: string
          title: Timestamp
          description: ISO timestamp when the summary was generated.
      type: object
      required:
        - unique_agents
        - total_completion_calls
        - successful_completions
        - completions_last_24h
        - completions_last_7d
        - timestamp
      title: MetricsSummaryOutput
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````