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

# List Dimensions

> Returns dimension definitions with their metric definitions.



## OpenAPI

````yaml /openapi/em-data-readiness-v2.yaml get /api/data-readiness/metrics/dimensions
openapi: 3.1.0
info:
  title: EM Data Readiness Service
  description: Data Readiness Service API for managing workflows, metrics, and data quality
  version: 4.3.0-dev1
servers: []
security:
  - BearerAuth: []
tags:
  - name: Health
    description: Service health monitoring. Check service status and version information.
  - name: Root
    description: Root endpoint providing service information and navigation links.
  - name: Configuration
    description: Service configuration endpoints. View current configuration values.
  - name: Workflows
    description: >-
      Workflow configuration and execution management. Create, configure, and
      run data quality workflows including definitions, configurations, runs,
      and tasks.
  - name: Data Assets
    description: >-
      Data catalog entity management. Manage databases, schemas, and tables
      metadata.
  - name: Metrics
    description: >-
      Data quality metrics and scorecards. Calculate scores, view trends, and
      analyze dimensions.
  - name: Violations
    description: >-
      Data quality violation management. View, acknowledge, and remediate
      detected violations.
  - name: Glossary
    description: >-
      Business glossary management. Create, verify, and organize business terms
      and definitions.
paths:
  /api/data-readiness/metrics/dimensions:
    get:
      tags:
        - Metrics
      summary: List Dimensions
      description: Returns dimension definitions with their metric definitions.
      operationId: list_dimensions
      parameters:
        - name: assessment_type
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by assessment type
            title: Assessment Type
          description: Filter by assessment type
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number (1-indexed)
            default: 1
            title: Page
          description: Page number (1-indexed)
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Items per page
            default: 20
            title: Per Page
          description: Items per page
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DimensionListResponse'
        '400':
          description: Bad Request - Invalid parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    DimensionListResponse:
      properties:
        dimensions:
          items:
            $ref: '#/components/schemas/DimensionResponse'
          type: array
          title: Dimensions
          description: List of dimensions
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
          description: Pagination metadata
      type: object
      required:
        - dimensions
        - pagination
      title: DimensionListResponse
      description: List of dimension definitions.
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorInfo'
          description: >-
            Error information object containing code, message, and optional
            details
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Request ID for debugging and support
          examples:
            - req_abc123xyz
      type: object
      required:
        - error
      title: ErrorResponse
      description: >-
        Standard error response model for API errors.


        Matches the structure returned by _handle_service_error in
        workflows/routes.py.

        The actual API response format is:

        {
            "error": {
                "code": "ERROR_CODE",
                "message": "Error message",
                "details": {...}
            },
            "request_id": "optional-request-id"
        }
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DimensionResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Unique dimension identifier
          examples:
            - 550e8400-e29b-41d4-a716-446655440021
        name:
          type: string
          title: Name
          description: Dimension name
          examples:
            - completeness
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
          description: Human-readable display name
          examples:
            - Completeness
        fqn:
          type: string
          title: Fqn
          description: Fully qualified name
          examples:
            - dimensions.completeness
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Description of the dimension
          examples:
            - Measures the completeness of metadata
        purpose:
          anyOf:
            - type: string
            - type: 'null'
          title: Purpose
          description: Purpose of the dimension
        assessment_type:
          type: string
          title: Assessment Type
          description: 'Type of assessment: ''metadata'' or ''data_quality'''
          examples:
            - metadata
        weight:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Weight
          description: Relative weight in overall score calculation
          examples:
            - '0.25'
        display_order:
          type: integer
          title: Display Order
          description: Display ordering
          examples:
            - 1
        is_active:
          type: boolean
          title: Is Active
          description: Whether the dimension is active
          examples:
            - true
        metric_definitions:
          items:
            $ref: '#/components/schemas/MetricDefinitionSummary'
          type: array
          title: Metric Definitions
          description: Metric definitions in this dimension
      type: object
      required:
        - id
        - name
        - fqn
        - assessment_type
        - weight
        - display_order
        - is_active
        - metric_definitions
      title: DimensionResponse
      description: Full dimension definition with its metric definitions.
    PaginationMeta:
      properties:
        page:
          type: integer
          title: Page
          description: Current page number (1-indexed)
        per_page:
          type: integer
          title: Per Page
          description: Items per page
        total:
          type: integer
          title: Total
          description: Total number of items
        total_pages:
          type: integer
          title: Total Pages
          description: Total number of pages
        has_next:
          type: boolean
          title: Has Next
          description: Whether there is a next page
        has_prev:
          type: boolean
          title: Has Prev
          description: Whether there is a previous page
      type: object
      required:
        - page
        - per_page
        - total
        - total_pages
        - has_next
        - has_prev
      title: PaginationMeta
      description: >-
        Standard pagination metadata for list responses.


        This model provides consistent pagination information across all
        paginated

        API responses in the service.
    ErrorInfo:
      properties:
        code:
          type: string
          title: Code
          description: >-
            Error code identifier (e.g., 'WORKFLOW_NOT_FOUND',
            'VALIDATION_ERROR')
          examples:
            - WORKFLOW_NOT_FOUND
        message:
          type: string
          title: Message
          description: Human-readable error message
          examples:
            - >-
              Workflow configuration with id
              '123e4567-e89b-12d3-a456-426614174000' not found
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Additional error details as a dictionary (flexible structure for
            business logic errors)
          examples:
            - workflow_id: 123e4567-e89b-12d3-a456-426614174000
      type: object
      required:
        - code
        - message
      title: ErrorInfo
      description: >-
        Nested error information object.


        Note: This model uses an untyped dict for `details` to match the
        flexible error

        structure used throughout the service layer (see WorkflowServiceError
        and similar).

        This is distinct from ErrorDetail, which is used for structured
        validation errors.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    MetricDefinitionSummary:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Unique metric definition identifier
          examples:
            - 550e8400-e29b-41d4-a716-446655440020
        name:
          type: string
          title: Name
          description: Metric name
          examples:
            - has_description
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
          description: Human-readable display name
          examples:
            - Has Description
        fqn:
          type: string
          title: Fqn
          description: Fully qualified name
          examples:
            - metrics.completeness.has_description
        unit:
          anyOf:
            - type: string
            - type: 'null'
          title: Unit
          description: Unit of measurement
          examples:
            - percent
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Description of the metric
        purpose:
          anyOf:
            - type: string
            - type: 'null'
          title: Purpose
          description: Purpose of the metric
        applicable_asset_types:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Applicable Asset Types
          description: Asset types this metric applies to
          examples:
            - - table
              - column
        is_active:
          type: boolean
          title: Is Active
          description: Whether the metric is active
          examples:
            - true
      type: object
      required:
        - id
        - name
        - fqn
        - is_active
      title: MetricDefinitionSummary
      description: Summary of a metric definition within a dimension.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token authentication. Include the token in the Authorization
        header as: `Authorization: Bearer <token>`. The JWT must contain valid
        client_id, and project_id claims for tenant isolation and SDK routing.

````