Skip to main content
GET
/
api
/
v1
/
beam
/
{config_id}
/
deploy
/
metrics
Get deployment metrics
curl --request GET \
  --url https://api.example.com/api/v1/beam/{config_id}/deploy/metrics
Returns throughput, latency, and error rate metrics for the deployment.
Required permission: read — owners, editors, readers, and members of teams shared via viewer_team.
Path parameters:
ParameterDescription
config_idPipeline configuration ID
Query parameters:
ParameterDefaultDescription
time_range1hTime range: 1h, 1d, or 1w
aggregatedfalsetrue returns a single summary, false returns time-series data points
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 
{
  "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": []
    }
  ]
}