---
title: "Get Pipeline Metrics Handler"
method: GET
path: "/api/v1/beam/{config_id}/deploy/metrics"
tags: ["BEAM"]
---

# Get Pipeline Metrics Handler

`GET /api/v1/beam/{config_id}/deploy/metrics`

Get metrics for a pipeline.

## Path parameters

- `config_id` string, required

## Query parameters

- `time_range` '1h' | '1d' | '1w'
- `aggregated` boolean — If True, returns aggregated pipeline metrics. If False, returns raw metric series.

## Response `200`

Successful Response

- union
  - PipelineMetricsResponse
    - `pipeline_id` string, required
    - `time_range` string, required
    - `messages_received_per_min` number, nullable
    - `messages_sent_per_min` number, nullable
    - `total_latency` LatencyPercentiles
      - `p50` number, nullable
      - `p90` number, nullable
      - `p99` number, nullable
      - `unit` string
    - `processing_latency` ProcessorLatency[]
      - `path` string, required
      - `latency` LatencyPercentiles
        - `p50` number, nullable
        - `p90` number, nullable
        - `p99` number, nullable
        - `unit` string
    - `processor_error_rate` number, nullable
    - `output_error_rate` number, nullable
    - `data_freshness_ms` number, nullable
  - RawMetricsResponse
    - `config_id` string, required
    - `metrics` MetricSeriesItem[], required
      - `metric_type` string, required
      - `points` MetricPoint[], required
        - `timestamp` string, date-time, required
        - `value` number, required
      - `tag_set` string[]

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/allium/apis/allium-account-api.md) · [All operations](https://skmtc.net/allium/apis/allium-account-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/allium/allium-account-api/versions/6c79c032c85d/schema)