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

# Get deployment metrics

> Returns throughput, latency, and error rate metrics for a deployed pipeline.

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

Returns throughput, latency, and error rate metrics for the deployment.

**Path parameters:**

| Parameter   | Description               |
| :---------- | :------------------------ |
| `config_id` | Pipeline configuration ID |

**Query parameters:**

| Parameter    | Default | Description                                                              |
| :----------- | :------ | :----------------------------------------------------------------------- |
| `time_range` | `1h`    | Time range: `1h`, `1d`, or `1w`                                          |
| `aggregated` | `false` | `true` returns a single summary, `false` returns time-series data points |

```bash theme={null}
curl -X GET "https://api.allium.so/api/v1/beam/${CONFIG_ID}/deploy/metrics?time_range=1h&aggregated=true" \
  -H "X-API-Key: ${ALLIUM_API_KEY}"
```

**Available metric types:** `messages_received`, `messages_sent`, `total_latency`, `processing_latency`, `processor_errors`, `output_errors`, `data_freshness`

<Tabs>
  <Tab title="Time-series (default)">
    ```json theme={null}
    {
      "config_id": "abc123",
      "metrics": [
        {
          "metric_type": "messages_received",
          "points": [
            { "timestamp": "2026-03-24T07:21:40Z", "value": 0.0 },
            { "timestamp": "2026-03-24T07:22:40Z", "value": 15.3 },
            { "timestamp": "2026-03-24T07:23:40Z", "value": 22.1 }
          ]
        },
        {
          "metric_type": "messages_sent",
          "points": []
        }
      ]
    }
    ```
  </Tab>

  <Tab title="Aggregated">
    ```json theme={null}
    {
      "pipeline_id": "abc123",
      "time_range": "1h",
      "messages_received_per_min": 411.98,
      "messages_sent_per_min": 411.98,
      "total_latency": {
        "p50": 222.55,
        "p90": 266.46,
        "p99": 266.46,
        "unit": "ms"
      },
      "processing_latency": [
        {
          "path": "path:v8-transform",
          "latency": { "p50": 1.21, "p90": 2.26, "p99": 2.26, "unit": "ms" }
        }
      ],
      "processor_error_rate": 0.0,
      "output_error_rate": 0.0,
      "data_freshness_ms": 2043.49
    }
    ```
  </Tab>
</Tabs>