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

# Get aggregated leaderboard data

> Retrieve aggregated leaderboard data for a specific configuration.



## OpenAPI

````yaml /openapi/admin.json get /leaderboards/{configId}/data
openapi: 3.1.0
info:
  title: Nudj Admin API
  version: 1.0.0
servers:
  - url: https://{subdomain}.nudj.cx/api/v2/admin
    description: Organization API Server
    variables:
      subdomain:
        description: Your organization's subdomain (required)
        default: your-org
security:
  - ApiToken: []
paths:
  /leaderboards/{configId}/data:
    get:
      tags:
        - Leaderboard
      summary: Get aggregated leaderboard data
      description: Retrieve aggregated leaderboard data for a specific configuration.
      operationId: getAggregatedLeaderboardByConfigId
      parameters:
        - in: path
          name: configId
          description: The ID of the leaderboard configuration
          schema:
            type: string
            pattern: ^[0-9a-fA-F]{24}$
            description: The ID of the leaderboard configuration
          required: true
        - in: query
          name: inHistoricPeriod
          schema:
            type: string
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          required: false
        - in: query
          name: skip
          schema:
            type: integer
            minimum: 0
            default: 0
          required: false
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeaderboardData'
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.NOT_FOUND'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
components:
  schemas:
    LeaderboardData:
      type: object
      properties:
        totalCount:
          type: number
        edges:
          type: array
          items:
            $ref: '#/components/schemas/LeaderboardEntry'
      required:
        - totalCount
        - edges
      description: Paginated leaderboard data with entries
      title: LeaderboardData
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Error
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.NOT_FOUND:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Not found
        code:
          type: string
          description: The error code
          example: NOT_FOUND
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Error
      description: The error information
      example:
        code: NOT_FOUND
        message: Not found
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Internal server error
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Error
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
    LeaderboardEntry:
      type: object
      properties:
        userId:
          type: string
          pattern: ^[0-9a-fA-F]{24}$
          description: The unique identifier of the user
        username:
          type: string
          description: The username of the user
        displayName:
          type:
            - string
            - 'null'
          description: The display name of the user, if set
        profilePictureUrl:
          type:
            - string
            - 'null'
          description: The URL of the user's profile picture, if set
        value:
          type: number
          description: The user's score/value on the leaderboard
      required:
        - userId
        - username
        - displayName
        - profilePictureUrl
        - value
      description: A single entry in a leaderboard representing a user's position
      title: LeaderboardEntry
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: x-api-token

````