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

# Industry Schema

> Returns the CB industry hierarchy as L1 through L6 rows for scope filters, facets, and hierarchy-aware analytics.



## OpenAPI

````yaml /openapi/consensus-data.yaml get /analytics/v2/metadata/industry-schema
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/industry-schema:
    get:
      tags:
        - metadata
      summary: Industry Schema
      description: >-
        Returns the CB industry hierarchy as L1 through L6 rows for scope
        filters, facets, and hierarchy-aware analytics.
      operationId: metadata_industry_schema_v2_metadata_industry_schema_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndustrySchemaMetadataResponse'
              example:
                industry:
                  levels:
                    CB_Industry: L1
                    CB_Super_Sector: L2
                    CB_Sector: L3
                    CB_Sub_Sector: L4
                  tree:
                    Financials:
                      Banks:
                        Banks:
                          - Banks
                      Financial Services:
                        Financial Services:
                          - Asset Managers
                          - Consumer Finance
                entity_types:
                  levels:
                    CB_Entity_Type: L1
                    CB_Entity_Sub_Type: L2
                  tree:
                    Corporates:
                      - Corporates
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    IndustrySchemaMetadataResponse:
      type: object
      description: Industry and entity-type hierarchy metadata.
      required:
        - industry
        - entity_types
      properties:
        industry:
          $ref: '#/components/schemas/HierarchyMetadata'
        entity_types:
          $ref: '#/components/schemas/HierarchyMetadata'
    HierarchyMetadata:
      type: object
      description: Hierarchy metadata with level labels and a nested tree.
      required:
        - levels
        - tree
      properties:
        levels:
          type: object
          additionalProperties:
            type: string
          description: Field names mapped to hierarchy levels.
        tree:
          type: object
          additionalProperties: true
          description: Nested hierarchy tree.
    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.

````