> ## 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.

# Get leaderboardprofile



## OpenAPI

````yaml https://megastream25-api.closebot.com/swagger/v1/swagger.json get /leaderboard/profile
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/profile:
    get:
      tags:
        - Leaderboard
      parameters:
        - name: scope
          in: query
          schema:
            type: string
            default: source
        - name: entityId
          in: query
          schema:
            type: string
        - name: compare
          in: query
          schema:
            type: string
            default: all
        - name: period
          in: query
          schema:
            type: string
            default: current
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetProfileResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetProfileResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetProfileResponse'
components:
  schemas:
    GetProfileResponse:
      required:
        - axes
        - entity
        - mySources
        - mySourcesTruncated
      type: object
      properties:
        entity:
          $ref: '#/components/schemas/LeaderboardProfileEntityDto'
        axes:
          type: array
          items:
            $ref: '#/components/schemas/LeaderboardAxisDto'
          description: One entry per headline metric, in display order. Drives the radar.
          nullable: true
        mySources:
          type: array
          items:
            $ref: '#/components/schemas/LeaderboardMySourceDto'
          description: >-
            The caller's own sources. Feeds the subject picker and the
            your-sources comparison,

            and never contains another tenant's data.
          nullable: true
        mySourcesTruncated:
          type: boolean
          description: >-
            True when
            Closebot.Api.Controllers.LeaderboardController.GetProfileResponse.MySources
            was capped.
      additionalProperties: false
    LeaderboardProfileEntityDto:
      required:
        - label
      type: object
      properties:
        label:
          type: string
          nullable: true
      additionalProperties: false
      description: >-
        What the axes describe, for the subject heading above the radar.
                    
        The label only. The id is whatever the caller passed as `entityId`, and
        the kind is

        whatever they passed as `scope`; neither told the client anything it did
        not already

        know.
    LeaderboardAxisDto:
      required:
        - format
        - higherIsBetter
        - label
        - metric
      type: object
      properties:
        metric:
          type: string
          nullable: true
        label:
          type: string
          nullable: true
        format:
          type: string
          nullable: true
        higherIsBetter:
          type: boolean
        current:
          $ref: '#/components/schemas/LeaderboardAxisPointDto'
        previous:
          $ref: '#/components/schemas/LeaderboardAxisPointDto'
      additionalProperties: false
      description: >-
        One radar axis: a metric, plus where the subject sits on it now and last
        month.
    LeaderboardMySourceDto:
      required:
        - id
        - name
      type: object
      properties:
        id:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
      additionalProperties: false
      description: >-
        One of the caller's own sources — enough to populate the subject picker,
        and no more.
                    
        Previously carried a full set of headline standings including cohort
        sizes. Nothing

        consumes them, so they are gone rather than left as an unused leak.
    LeaderboardAxisPointDto:
      required:
        - percentile
        - value
      type: object
      properties:
        percentile:
          type: number
          description: '"Top N%" within the cohort.'
          format: double
        value:
          type: number
          format: double
      additionalProperties: false
      description: >-
        The caller's own standing on one metric in one period.
                    
        A percentile and a value, never a rank or a cohort size. The radar
        derives its axis from

        `100 - percentile`; publishing an exact placement alongside the
        percentile would be

        two equations in `(rank, N)` and would solve for the population.
  securitySchemes:
    Key:
      type: apiKey
      description: CloseBot API Key Authorization
      name: X-CB-KEY
      in: header

````