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

# Get Sources Hall Of Fame

> Sources' podium places across current boards. No credential required.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/leaderboards/hall-of-fame/sources
openapi: 3.1.0
info:
  description: >-
    Access to one organization's brands, as the member who created the API key.
    A read-only key reads; a full-access key also starts, edits and runs that
    member's Snapshots on the organization's Snapshot credits. Each key may make
    120 requests a minute. Separate organization service tokens can start
    Snapshots and Full audits and read service audits. Every error is an RFC
    9457 problem (`application/problem+json`) whose `code` names it.
  summary: Read your brands' AI visibility and run Snapshots in Heralded.
  title: Heralded API
  version: '1'
servers:
  - url: https://api.heralded.ai
security: []
paths:
  /v1/leaderboards/hall-of-fame/sources:
    get:
      tags:
        - v1
      summary: Get Sources Hall Of Fame
      description: Sources' podium places across current boards. No credential required.
      operationId: getLeaderboardSourcesHallOfFame
      parameters:
        - description: Maximum rows to return, up to 100.
          in: query
          name: limit
          required: false
          schema:
            default: 10
            description: Maximum rows to return, up to 100.
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - description: Rows to skip.
          in: query
          name: offset
          required: false
          schema:
            default: 0
            description: Rows to skip.
            minimum: 0
            title: Offset
            type: integer
        - description: The preceding page's next_cursor.
          in: query
          name: cursor
          required: false
          schema:
            anyOf:
              - maxLength: 4096
                type: string
              - type: 'null'
            description: The preceding page's next_cursor.
            title: Cursor
        - description: An industry slug from the facets.
          in: query
          name: industry
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: An industry slug from the facets.
            title: Industry
        - description: >-
            Global, an ISO country, or `europe` for the sum of the seven
            countries' boards. The pooled Europe board never counts. Omit to
            count Global and all countries.
          in: query
          name: market
          required: false
          schema:
            anyOf:
              - pattern: ^(?:[A-Z]{2}|global|europe)$
                type: string
              - type: 'null'
            description: >-
              Global, an ISO country, or `europe` for the sum of the seven
              countries' boards. The pooled Europe board never counts. Omit to
              count Global and all countries.
            title: Market
        - description: >-
            ISO country to leave out of a `market=europe` scope, or, with
            `market` omitted, of Global and all countries.
          in: query
          name: exclude_country
          required: false
          schema:
            anyOf:
              - pattern: ^[A-Z]{2}$
                type: string
              - type: 'null'
            description: >-
              ISO country to leave out of a `market=europe` scope, or, with
              `market` omitted, of Global and all countries.
            title: Exclude Country
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourcesHallOfFame'
          description: Successful Response
        '404':
          content:
            application/problem+json:
              example:
                code: not_found
                detail: Nothing here that this API key can read.
                instance: example-request-id
                status: 404
                title: Not Found
                type: https://docs.heralded.ai/errors-and-limits#not_found
              schema:
                $ref: '#/components/schemas/Problem'
          description: No published leaderboard contains this brand or source.
        '422':
          content:
            application/problem+json:
              example:
                code: invalid_request
                detail: The request's parameters are invalid; `errors` names each one.
                errors:
                  - loc:
                      - query
                      - limit
                    msg: Input should be greater than or equal to 1
                    type: greater_than_equal
                instance: example-request-id
                status: 422
                title: Unprocessable Content
                type: https://docs.heralded.ai/errors-and-limits#invalid_request
              schema:
                $ref: '#/components/schemas/ValidationProblem'
          description: Invalid filters or pagination.
        '429':
          content:
            application/problem+json:
              example:
                code: rate_limited
                detail: >-
                  This caller is past its requests for the minute. Retry after
                  the seconds in Retry-After.
                instance: example-request-id
                rate_limit:
                  limit: 60
                  remaining: 0
                  reset: 60
                  window: 60
                status: 429
                title: Too Many Requests
                type: https://docs.heralded.ai/errors-and-limits#rate_limited
              schema:
                $ref: '#/components/schemas/RateLimitProblem'
          description: The anonymous IP or site-key bucket is exhausted.
          headers:
            Retry-After:
              schema:
                example: 60
                type: integer
components:
  schemas:
    SourcesHallOfFame:
      examples:
        - limit: 20
          meta:
            data_as_of: null
            last_attempt_failed: false
            partial: false
            query: {}
            surfaces: {}
            updating: false
          next_cursor: null
          offset: 0
          rows: []
          total: 0
      properties:
        limit:
          title: Limit
          type: integer
        meta:
          $ref: '#/components/schemas/Meta'
          description: Normalized query and newest included scan.
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Pass as cursor with the same query to read the next page; null at
            the end.
          title: Next Cursor
        offset:
          title: Offset
          type: integer
        rows:
          items:
            $ref: '#/components/schemas/SourceMedals'
          title: Rows
          type: array
        total:
          title: Total
          type: integer
      required:
        - meta
        - next_cursor
        - total
        - limit
        - offset
        - rows
      title: SourcesHallOfFame
      type: object
    Problem:
      description: An RFC 9457 problem linking its code to human-readable documentation.
      properties:
        code:
          title: Code
          type: string
        detail:
          title: Detail
          type: string
        instance:
          default: ''
          title: Instance
          type: string
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          title: Type
          type: string
      required:
        - type
        - title
        - status
        - detail
        - code
        - instance
      title: Problem
      type: object
    ValidationProblem:
      properties:
        code:
          title: Code
          type: string
        detail:
          title: Detail
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ValidationIssue'
          title: Errors
          type: array
        instance:
          default: ''
          title: Instance
          type: string
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          title: Type
          type: string
      required:
        - type
        - title
        - status
        - detail
        - code
        - instance
        - errors
      title: ValidationProblem
      type: object
    RateLimitProblem:
      properties:
        code:
          title: Code
          type: string
        detail:
          title: Detail
          type: string
        instance:
          default: ''
          title: Instance
          type: string
        rate_limit:
          $ref: '#/components/schemas/RateLimitValues'
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          title: Type
          type: string
      required:
        - type
        - title
        - status
        - detail
        - code
        - instance
        - rate_limit
      title: RateLimitProblem
      type: object
    Meta:
      properties:
        data_as_of:
          anyOf:
            - $ref: '#/components/schemas/DataAsOf'
            - type: 'null'
        last_attempt_failed:
          default: false
          description: The newest attempt failed; the last good result is displayed.
          title: Last Attempt Failed
          type: boolean
        partial:
          default: false
          description: The displayed response includes a partial report.
          title: Partial
          type: boolean
        query:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          title: Query
          type: object
        surfaces:
          additionalProperties:
            $ref: '#/components/schemas/SurfaceFreshness'
          description: >-
            Freshness by Command Center surface key. Each entry describes its
            own displayed result, including results without a scan.
          title: Surfaces
          type: object
        updating:
          default: false
          description: A newer result is being produced or is not yet displayed.
          title: Updating
          type: boolean
      required:
        - query
        - data_as_of
        - partial
        - updating
        - last_attempt_failed
        - surfaces
      title: Meta
      type: object
    SourceMedals:
      properties:
        answers:
          title: Answers
          type: integer
        boards:
          title: Boards
          type: integer
        citations:
          title: Citations
          type: integer
        domain:
          title: Domain
          type: string
        europe_first_places:
          items:
            $ref: '#/components/schemas/FirstPlace'
          title: Europe First Places
          type: array
        first_places:
          items:
            $ref: '#/components/schemas/FirstPlace'
          title: First Places
          type: array
        medals:
          $ref: '#/components/schemas/Medals'
        rank:
          title: Rank
          type: integer
      required:
        - rank
        - domain
        - answers
        - citations
        - boards
        - medals
        - first_places
        - europe_first_places
      title: SourceMedals
      type: object
    ValidationIssue:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Loc
          type: array
        msg:
          title: Msg
          type: string
        type:
          title: Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationIssue
      type: object
    RateLimitValues:
      properties:
        limit:
          title: Limit
          type: integer
        remaining:
          title: Remaining
          type: integer
        reset:
          title: Reset
          type: integer
        window:
          title: Window
          type: integer
      required:
        - limit
        - window
        - remaining
        - reset
      title: RateLimitValues
      type: object
    DataAsOf:
      properties:
        completed_at:
          format: date-time
          title: Completed At
          type: string
        id:
          format: uuid
          title: Id
          type: string
      required:
        - id
        - completed_at
      title: DataAsOf
      type: object
    JsonValue: {}
    SurfaceFreshness:
      properties:
        as_of:
          anyOf:
            - $ref: '#/components/schemas/SurfaceAsOf'
            - type: 'null'
          description: The result displayed here.
        last_attempt_failed:
          default: false
          description: The newest attempt failed; any displayed result is retained.
          title: Last Attempt Failed
          type: boolean
        partial:
          default: false
          description: The displayed report is partial.
          title: Partial
          type: boolean
        updating:
          default: false
          description: A newer attempt exists whose result is not yet displayed.
          title: Updating
          type: boolean
      required:
        - as_of
        - partial
        - updating
        - last_attempt_failed
      title: SurfaceFreshness
      type: object
    FirstPlace:
      properties:
        industry:
          title: Industry
          type: string
        market:
          title: Market
          type: string
        path:
          title: Path
          type: string
      required:
        - industry
        - market
        - path
      title: FirstPlace
      type: object
    Medals:
      properties:
        first:
          default: 0
          title: First
          type: integer
        second:
          default: 0
          title: Second
          type: integer
        third:
          default: 0
          title: Third
          type: integer
      required:
        - first
        - second
        - third
      title: Medals
      type: object
    SurfaceAsOf:
      properties:
        at:
          description: When the displayed result was measured.
          format: date-time
          title: At
          type: string
        scan_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: The result's scan, null for a timestamp-only result.
          title: Scan Id
      required:
        - scan_id
        - at
      title: SurfaceAsOf
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.