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

# The metrics a board can be ranked by. Clients should build their columns from this rather
than hardcoding a list, so changing the headline set needs no frontend deploy.



## OpenAPI

````yaml https://megastream25-api.closebot.com/swagger/v1/swagger.json get /leaderboard/metrics
openapi: 3.0.4
info:
  title: CloseBot API
  version: v1
servers:
  - url: https://api.closebot.com
    description: CloseBot API Endpoint
security:
  - Key: []
tags:
  - name: Account
  - name: AccountNotification
  - name: Agency
  - name: Analytics
  - name: Billing
  - name: Bot
  - name: BotMetric
  - name: BotSourceVariable
  - name: BotTemplate
  - name: BotTesting
  - name: Dashboard
  - name: Hierarchy
  - name: Lead
  - name: Leaderboard
  - name: Library
  - name: LiveDemo
  - name: Notification
  - name: Persona
  - name: Report
  - name: SmartFAQ
  - name: Source
  - name: SourceChannel
  - name: Webhook
paths:
  /leaderboard/metrics:
    get:
      tags:
        - Leaderboard
      summary: >-
        The metrics a board can be ranked by. Clients should build their columns
        from this rather

        than hardcoding a list, so changing the headline set needs no frontend
        deploy.
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LeaderboardMetricDto'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LeaderboardMetricDto'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LeaderboardMetricDto'
components:
  schemas:
    LeaderboardMetricDto:
      required:
        - description
        - format
        - higherIsBetter
        - isHeadline
        - key
        - label
        - supportsSourceScope
      type: object
      properties:
        key:
          type: string
          description: Wire key to pass as `metric` on GET /leaderboard/board.
          nullable: true
        label:
          type: string
          description: Display name.
          nullable: true
        description:
          type: string
          description: What the metric counts, and anything it deliberately excludes.
          nullable: true
        guidance:
          type: string
          description: >-
            One sentence on how to move this metric, for the board's headline
            figure.
                        
            Null outside the headline set, and clients must render nothing
            rather than an empty

            line — widening `Headline` before its copy is written should degrade
            to silence,

            not to a stray label.
          nullable: true
        format:
          type: string
          description: >-
            How to render the value: integer, decimal, duration (milliseconds),
            currency (USD),

            or score (0-100).
          nullable: true
        higherIsBetter:
          type: boolean
          description: >-
            False when the board ranks ascending — cost, latency and error
            metrics, where #1

            means least rather than most. Clients should say so next to the
            metric; a user who

            assumes "more is better" will read an AI-errors board exactly
            backwards.
        supportsSourceScope:
          type: boolean
          description: >-
            False for agency-wide metrics. Requesting `scope=source` for one of
            these is a 400.
        isHeadline:
          type: boolean
          description: >-
            True for the metrics the board actually surfaces — the radar's axes
            and the table's

            columns, in the order they appear here. Everything else is still
            ranked and stored,

            just not shown.
      additionalProperties: false
  securitySchemes:
    Key:
      type: apiKey
      description: CloseBot API Key Authorization
      name: X-CB-KEY
      in: header

````