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

# Available Data Columns

> Returns a flat catalog of public input columns with metadata such as type, scopeable, facetable, and entitlement. This endpoint describes request-side input columns only; it does not describe route response fields or result_filter fields.



## OpenAPI

````yaml /openapi/consensus-data.yaml get /analytics/v2/metadata/columns
openapi: 3.1.0
info:
  title: Credit Benchmark API
  description: |
    Authentication, entity resolution, data, analytics, and metadata endpoints.
  version: 1.0.0
  contact:
    name: Credit Benchmark API Support
    email: api-support@creditbenchmark.com
    url: https://creditbenchmark.com/support
  license:
    name: Proprietary
    url: https://creditbenchmark.com/terms
servers:
  - url: https://gateway.creditbenchmark.com
    description: Production gateway
security:
  - BearerAuth: []
tags:
  - name: authentication
    description: Token generation endpoints.
    x-group: Authentication
  - name: entity-resolution
    description: Entity name resolution endpoints.
    x-group: Entity Resolution
  - name: data
    description: Raw data extraction endpoints.
    x-group: Data
  - name: analytics
    description: Analytics endpoints.
    x-group: Analytics
  - name: metadata
    description: Metadata discovery endpoints.
    x-group: Metadata
paths:
  /analytics/v2/metadata/columns:
    get:
      tags:
        - metadata
      summary: Available Data Columns
      description: >-
        Returns a flat catalog of public input columns with metadata such as
        type, scopeable, facetable, and entitlement. This endpoint describes
        request-side input columns only; it does not describe route response
        fields or result_filter fields.
      operationId: metadata_columns_v2_metadata_columns_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataColumnsResponse'
              example:
                CB_ID:
                  type: String
                  scopeable: false
                  facetable: false
                  entitlement: null
                CB_Country:
                  type: String
                  scopeable: true
                  facetable: true
                  entitlement: null
                CB_CCR_100_PDMid:
                  type: Float64
                  scopeable: true
                  facetable: false
                  entitlement: null
                SP_ForeignCurrencyLongTerm:
                  type: String
                  scopeable: true
                  facetable: true
                  entitlement: SP
                Client_Rating_Client_Scale:
                  type: String
                  scopeable: true
                  facetable: true
                  entitlement: CLIENT_DATA
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    DataColumnsResponse:
      type: object
      description: Public input column catalog.
      additionalProperties:
        $ref: '#/components/schemas/DataColumnMetadata'
    DataColumnMetadata:
      type: object
      additionalProperties: false
      required:
        - type
        - scopeable
        - facetable
        - entitlement
      properties:
        type:
          type: string
          description: Column type.
        scopeable:
          type: boolean
          description: Whether the column can be used in `scope.filters`.
        facetable:
          type: boolean
          description: Whether the column can be used as a facet column.
        entitlement:
          type:
            - string
            - 'null'
          enum:
            - SP
            - FITCH
            - CLIENT_DATA
            - null
          description: Required entitlement, if any.
    UnauthorizedError:
      type: object
      required:
        - detail
      properties:
        detail:
          type: string
    SimpleError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    RateLimitError:
      type: object
      required:
        - error
        - detail
      properties:
        error:
          type: string
        detail:
          type: string
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
          example:
            detail: Unauthorized request
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SimpleError'
          example:
            error: Client-backed analytics inputs require contributor entitlement.
    TooManyRequests:
      description: Too many requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitError'
          example:
            error: Rate limit exceeded
            detail: 60 per 1 minute
    InternalServerError:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SimpleError'
          example:
            error: >-
              An error occurred while processing your request. Please try again
              later.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT bearer token.

````