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

# Dashboard metrics

> dashboard metrics. POST /api/v1/telemetry/metrics/dashboard. Uses the same payload, validation, revision checks and response as the unified HTTP API.

ReferenceApplies to: Unified engine deployments

## Related guidance

[Addresses and access](https://docs.e6data.com/transformation/http/access.md) · [Request identity](https://docs.e6data.com/transformation/http/request-identity.md) · [Errors and recovery](https://docs.e6data.com/transformation/http/errors.md) · [Pagination and results](https://docs.e6data.com/transformation/http/results.md)


## OpenAPI

````yaml openapi/transformation.json POST /api/v1/telemetry/metrics/dashboard
openapi: 3.1.0
info:
  description: >-
    HTTP contracts for the Unified engine. Requests use the connected
    deployment's access model and configured owner. Response examples are
    illustrative; inspect your engine response in your client. SQL-managed
    secrets, credentials, streaming pipelines and maintenance run through
    session operations.
  title: Laminar Unified HTTP API
  version: v1
servers:
  - url: https://engine.example.com
    description: >-
      Example engine origin. Replace it with your deployment URL and any API
      mount prefix.
security: []
paths:
  /api/v1/telemetry/metrics/dashboard:
    post:
      tags:
        - Observability
      summary: dashboard metrics
      description: >-
        dashboard metrics. POST /api/v1/telemetry/metrics/dashboard. Uses the
        same payload, validation, revision checks and response as the unified
        HTTP API.
      operationId: dashboard_metrics
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                dashboard:
                  additionalProperties: false
                  properties:
                    end_unix_millis:
                      minimum: 0
                      type: integer
                    panels:
                      items:
                        additionalProperties: false
                        properties:
                          denominator:
                            anyOf:
                              - additionalProperties: false
                                properties:
                                  filters:
                                    additionalProperties:
                                      items:
                                        type: string
                                      type: array
                                    type: object
                                  metric:
                                    type: string
                                  stat:
                                    enum:
                                      - gauge
                                      - rate
                                      - p50
                                      - p95
                                      - age
                                      - never
                                required:
                                  - metric
                                type: object
                              - type: 'null'
                          group_by:
                            items:
                              type: string
                            type: array
                          id:
                            type: string
                          operand:
                            additionalProperties: false
                            properties:
                              filters:
                                additionalProperties:
                                  items:
                                    type: string
                                  type: array
                                type: object
                              metric:
                                type: string
                              stat:
                                enum:
                                  - gauge
                                  - rate
                                  - p50
                                  - p95
                                  - age
                                  - never
                            required:
                              - metric
                            type: object
                          reduction:
                            enum:
                              - sum
                              - max
                          top:
                            minimum: 1
                            type:
                              - integer
                              - 'null'
                        required:
                          - id
                          - operand
                        type: object
                      type: array
                    start_unix_millis:
                      minimum: 0
                      type: integer
                  required:
                    - start_unix_millis
                    - end_unix_millis
                    - panels
                  type: object
                filters:
                  additionalProperties: false
                  properties:
                    cell_execution_id:
                      type: string
                    component:
                      type: string
                    continuation_token:
                      type: string
                    end_unix_millis:
                      minimum: 0
                      type: integer
                    latest:
                      type: boolean
                    limit:
                      minimum: 1
                      type: integer
                    max_points:
                      minimum: 1
                      type: integer
                    max_series:
                      minimum: 1
                      type: integer
                    name:
                      type: string
                    notebook_id:
                      type: string
                    notebook_run_id:
                      type: string
                    operation_id:
                      type: string
                    process_instance:
                      type: string
                    request_id:
                      type: string
                    role:
                      type: string
                    session_id:
                      type: string
                    severity:
                      enum:
                        - debug
                        - info
                        - warn
                        - error
                    start_unix_millis:
                      minimum: 0
                      type: integer
                    task_attempt_id:
                      type: string
                    task_run_id:
                      type: string
                    trace_id:
                      type: string
                    worker_id:
                      format: uuid
                      type: string
                    workload_id:
                      type: string
                    workload_run_id:
                      type: string
                  required: []
                  type: object
              required:
                - dashboard
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/telemetry_src_history_models_rs_HistoryPage
          description: Successful response.
        default:
          content:
            application/json:
              example:
                error:
                  code: invalid_request
                  message: Check the request fields
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A rejected or failed request. Inspect error.code before retrying.
components:
  schemas:
    telemetry_src_history_models_rs_HistoryPage:
      properties:
        continuation_token:
          anyOf:
            - type: string
            - type: 'null'
        coverage:
          $ref: '#/components/schemas/telemetry_src_history_models_rs_HistoryCoverage'
        dashboard:
          anyOf:
            - $ref: '#/components/schemas/app_dashboards_src_error_rs_DashboardResult'
            - type: 'null'
        records:
          items:
            $ref: '#/components/schemas/telemetry_src_history_models_rs_StoredRecord'
          type: array
        truncated:
          type: boolean
      required:
        - records
        - coverage
        - continuation_token
        - truncated
      type: object
    ApiError:
      properties:
        error:
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
    telemetry_src_history_models_rs_HistoryCoverage:
      properties:
        budget_exhausted:
          type: boolean
        collected_through_unix_millis:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        dropped_records:
          minimum: 0
          type: integer
        durable_through_unix_millis:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        evicted_records:
          minimum: 0
          type: integer
        expired:
          type: boolean
        gaps:
          items:
            $ref: '#/components/schemas/telemetry_src_history_models_rs_HistoryGap'
          type: array
        incomplete:
          type: boolean
        newest_unix_millis:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        oldest_unix_millis:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        requested_end_unix_millis:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        requested_start_unix_millis:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        resolutions_millis:
          items:
            minimum: 0
            type: integer
          type: array
        retained_bytes:
          minimum: 0
          type: integer
      required:
        - requested_start_unix_millis
        - requested_end_unix_millis
        - oldest_unix_millis
        - newest_unix_millis
        - collected_through_unix_millis
        - durable_through_unix_millis
        - resolutions_millis
        - expired
        - incomplete
        - budget_exhausted
        - dropped_records
        - evicted_records
        - retained_bytes
        - gaps
      type: object
    app_dashboards_src_error_rs_DashboardResult:
      description: >-
        Serialized Result; provider-specific fields retain their original JSON
        representation.
      x-rust-type: Result
    telemetry_src_history_models_rs_StoredRecord:
      properties:
        commit_sequence:
          minimum: 0
          type: integer
        gauge:
          anyOf:
            - $ref: >-
                #/components/schemas/telemetry_src_history_models_rs_GaugeAggregate
            - type: 'null'
          description: >-
            Per-bucket mergeable statistics for gauges. Counter/histogram values
            remain cumulative within their reset segment; repeated snapshots are
            never summed.
        received_unix_millis:
          minimum: 0
          type: integer
        record:
          $ref: '#/components/schemas/telemetry_src_history_models_rs_HistoryRecord'
        resolution_millis:
          minimum: 0
          type: integer
        worker_id:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_WorkerId'
            - type: 'null'
      required:
        - worker_id
        - commit_sequence
        - record
        - resolution_millis
        - received_unix_millis
      type: object
    telemetry_src_history_models_rs_HistoryGap:
      properties:
        end_unix_millis:
          minimum: 0
          type: integer
        reason:
          type: string
        start_unix_millis:
          minimum: 0
          type: integer
      required:
        - start_unix_millis
        - end_unix_millis
        - reason
      type: object
    telemetry_src_history_models_rs_GaugeAggregate:
      $ref: '#/components/schemas/telemetry_src_models_rs_GaugeStatistics'
    telemetry_src_history_models_rs_HistoryRecord:
      oneOf:
        - properties:
            record:
              $ref: '#/components/schemas/telemetry_src_models_rs_MetricSample'
            signal:
              const: metric
          required:
            - signal
            - record
          type: object
        - properties:
            record:
              $ref: '#/components/schemas/telemetry_src_models_rs_LogRecord'
            signal:
              const: log
          required:
            - signal
            - record
          type: object
        - properties:
            record:
              $ref: '#/components/schemas/telemetry_src_models_rs_SpanRecord'
            signal:
              const: span
          required:
            - signal
            - record
          type: object
    shared_common_src_lib_rs_WorkerId:
      format: uuid
      type: string
    telemetry_src_models_rs_GaugeStatistics:
      properties:
        count:
          minimum: 0
          type: integer
        max:
          type: number
        min:
          type: number
        sum:
          type: number
      required:
        - min
        - max
        - sum
        - count
      type: object
    telemetry_src_models_rs_MetricSample:
      properties:
        attributes:
          $ref: '#/components/schemas/telemetry_src_models_rs_Attributes'
        gauge:
          anyOf:
            - $ref: '#/components/schemas/telemetry_src_models_rs_GaugeStatistics'
            - type: 'null'
          description: >-
            Mergeable statistics for gauge observations since the previous
            collection.
        name:
          type: string
        scope:
          anyOf:
            - $ref: '#/components/schemas/telemetry_src_models_rs_ExecutionScope'
            - type: 'null'
        sequence:
          minimum: 0
          type: integer
        series_start_sequence:
          description: >-
            The first observation in this cumulative segment. A changed value
            marks a reset.
          minimum: 0
          type: integer
        source:
          $ref: '#/components/schemas/telemetry_src_models_rs_SourceIdentity'
        start_unix_nanos:
          description: Wall time of the first observation in this cumulative reset segment.
          minimum: 0
          type: integer
        unit:
          type: string
        unix_nanos:
          minimum: 0
          type: integer
        value:
          $ref: '#/components/schemas/telemetry_src_models_rs_MetricValue'
      required:
        - start_unix_nanos
        - scope
        - series_start_sequence
        - source
        - sequence
        - name
        - unit
        - attributes
        - unix_nanos
        - value
      type: object
    telemetry_src_models_rs_LogRecord:
      properties:
        attributes:
          $ref: '#/components/schemas/telemetry_src_models_rs_Attributes'
        context:
          anyOf:
            - $ref: '#/components/schemas/telemetry_src_models_rs_TraceContext'
            - type: 'null'
        message:
          type: string
        scope:
          anyOf:
            - $ref: '#/components/schemas/telemetry_src_models_rs_ExecutionScope'
            - type: 'null'
        sequence:
          minimum: 0
          type: integer
        severity:
          $ref: '#/components/schemas/telemetry_src_models_rs_Severity'
        source:
          $ref: '#/components/schemas/telemetry_src_models_rs_SourceIdentity'
        unix_nanos:
          minimum: 0
          type: integer
      required:
        - scope
        - source
        - sequence
        - unix_nanos
        - severity
        - message
        - attributes
        - context
      type: object
    telemetry_src_models_rs_SpanRecord:
      properties:
        attributes:
          $ref: '#/components/schemas/telemetry_src_models_rs_Attributes'
        context:
          $ref: '#/components/schemas/telemetry_src_models_rs_TraceContext'
        duration_nanos:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        end_unix_nanos:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        events:
          items:
            $ref: '#/components/schemas/telemetry_src_models_rs_SpanEvent'
          type: array
        kind:
          $ref: '#/components/schemas/telemetry_src_models_rs_SpanKind'
        links:
          items:
            $ref: '#/components/schemas/telemetry_src_models_rs_SpanLink'
          type: array
        name:
          type: string
        outcome:
          anyOf:
            - $ref: '#/components/schemas/telemetry_src_models_rs_Outcome'
            - type: 'null'
        parent:
          anyOf:
            - $ref: '#/components/schemas/telemetry_src_models_rs_TraceContext'
            - type: 'null'
        scope:
          anyOf:
            - $ref: '#/components/schemas/telemetry_src_models_rs_ExecutionScope'
            - type: 'null'
        sequence:
          minimum: 0
          type: integer
        source:
          $ref: '#/components/schemas/telemetry_src_models_rs_SourceIdentity'
        start_unix_nanos:
          minimum: 0
          type: integer
      required:
        - scope
        - source
        - sequence
        - context
        - parent
        - name
        - kind
        - attributes
        - start_unix_nanos
        - end_unix_nanos
        - duration_nanos
        - outcome
      type: object
    telemetry_src_models_rs_Attributes:
      additionalProperties:
        type: string
      type: object
    telemetry_src_models_rs_ExecutionScope:
      oneOf:
        - allOf:
            - properties:
                level:
                  const: workload
              required:
                - level
              type: object
            - properties:
                workload_id:
                  $ref: '#/components/schemas/shared_common_src_lib_rs_WorkloadId'
              required:
                - workload_id
              type: object
        - allOf:
            - properties:
                level:
                  const: run
              required:
                - level
              type: object
            - properties:
                workload_id:
                  $ref: '#/components/schemas/shared_common_src_lib_rs_WorkloadId'
                workload_run_id:
                  $ref: '#/components/schemas/shared_common_src_lib_rs_WorkloadRunId'
              required:
                - workload_id
                - workload_run_id
              type: object
        - allOf:
            - properties:
                level:
                  const: task
              required:
                - level
              type: object
            - properties:
                task_run_id:
                  $ref: '#/components/schemas/shared_common_src_lib_rs_TaskRunId'
                workload_id:
                  $ref: '#/components/schemas/shared_common_src_lib_rs_WorkloadId'
                workload_run_id:
                  $ref: '#/components/schemas/shared_common_src_lib_rs_WorkloadRunId'
              required:
                - workload_id
                - workload_run_id
                - task_run_id
              type: object
        - allOf:
            - properties:
                level:
                  const: attempt
              required:
                - level
              type: object
            - properties:
                task_attempt_id:
                  $ref: '#/components/schemas/shared_common_src_lib_rs_TaskAttemptId'
                task_run_id:
                  $ref: '#/components/schemas/shared_common_src_lib_rs_TaskRunId'
                workload_id:
                  $ref: '#/components/schemas/shared_common_src_lib_rs_WorkloadId'
                workload_run_id:
                  $ref: '#/components/schemas/shared_common_src_lib_rs_WorkloadRunId'
              required:
                - workload_id
                - workload_run_id
                - task_run_id
                - task_attempt_id
              type: object
    telemetry_src_models_rs_SourceIdentity:
      properties:
        process_instance:
          format: uuid
          type: string
        role:
          type: string
        service:
          type: string
      required:
        - service
        - process_instance
        - role
      type: object
    telemetry_src_models_rs_MetricValue:
      oneOf:
        - allOf:
            - properties:
                kind:
                  const: up_down_counter
              required:
                - kind
              type: object
            - properties:
                value:
                  type: number
              required:
                - value
              type: object
        - allOf:
            - properties:
                kind:
                  const: counter
              required:
                - kind
              type: object
            - properties:
                value:
                  type: number
              required:
                - value
              type: object
        - allOf:
            - properties:
                kind:
                  const: gauge
              required:
                - kind
              type: object
            - properties:
                value:
                  type: number
              required:
                - value
              type: object
        - allOf:
            - properties:
                kind:
                  const: histogram
              required:
                - kind
              type: object
            - properties:
                bounds:
                  items:
                    type: number
                  type: array
                buckets:
                  items:
                    minimum: 0
                    type: integer
                  type: array
                count:
                  minimum: 0
                  type: integer
                max:
                  type: number
                min:
                  type: number
                sum:
                  type: number
              required:
                - count
                - sum
                - min
                - max
                - bounds
                - buckets
              type: object
    telemetry_src_models_rs_TraceContext:
      properties:
        span_id:
          minimum: 0
          type: integer
        trace_flags:
          minimum: 0
          type: integer
        trace_id:
          format: uuid
          type: string
      required:
        - trace_id
        - span_id
        - trace_flags
      type: object
    telemetry_src_models_rs_Severity:
      oneOf:
        - const: debug
          type: string
        - const: info
          type: string
        - const: warn
          type: string
        - const: error
          type: string
    telemetry_src_models_rs_SpanEvent:
      properties:
        attributes:
          $ref: '#/components/schemas/telemetry_src_models_rs_Attributes'
        name:
          type: string
        unix_nanos:
          minimum: 0
          type: integer
      required:
        - name
        - unix_nanos
        - attributes
      type: object
    telemetry_src_models_rs_SpanKind:
      oneOf:
        - const: internal
          type: string
        - const: server
          type: string
        - const: client
          type: string
        - const: producer
          type: string
        - const: consumer
          type: string
    telemetry_src_models_rs_SpanLink:
      properties:
        attributes:
          $ref: '#/components/schemas/telemetry_src_models_rs_Attributes'
        context:
          $ref: '#/components/schemas/telemetry_src_models_rs_TraceContext'
      required:
        - context
        - attributes
      type: object
    telemetry_src_models_rs_Outcome:
      oneOf:
        - const: success
          type: string
        - const: error
          type: string
        - const: cancelled
          type: string
    shared_common_src_lib_rs_WorkloadId:
      format: uuid
      type: string
    shared_common_src_lib_rs_WorkloadRunId:
      format: uuid
      type: string
    shared_common_src_lib_rs_TaskRunId:
      format: uuid
      type: string
    shared_common_src_lib_rs_TaskAttemptId:
      format: uuid
      type: string

````

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