---
title: "GET /v1/metrics/summary"
method: GET
path: "/v1/metrics/summary"
---

# GET /v1/metrics/summary

`GET /v1/metrics/summary`

Get aggregated metrics (runs time-series, failure rate, top errors, recent activity) in a single request.

## Query parameters

- `from` integer, required
- `to` integer, required
- `granularity` string, required
- `topErrorsLimit` integer
- `recentActivityLimit` integer
- `status` string

## Response `200`

OK

- GetMetricsSummarySuccessResponse
  - `code` integer
  - `data` MetricsSummaryData
    - `failureRate` FailureRateStats
      - `failed` integer
      - `failureRate` number — percentage (0-100)
      - `partial` integer
      - `total` integer
    - `failureRateError` string
    - `recentActivity` RecentRun[]
      - `durationMs` number
      - `error` string
      - `finishedAt` string
      - `runId` string
      - `startedAt` string
      - `status` 'running' | 'waiting' | 'success' | 'partial' | 'failure' | 'cancelled'
      - `workflowId` string
      - `workflowName` string
    - `recentActivityError` string
    - `runsTimeSeries` RunsTimeSeriesData
      - `data` RunsTimeSeriesPoint[] — Time-series data points
        - `bucketStart` string
        - `failure` integer
        - `partial` integer
        - `success` integer
        - `total` integer
      - `granularity` string — "hourly" or "daily"
    - `runsTimeSeriesError` string
    - `topErrors` TopError[]
      - `count` integer
      - `error` string
      - `lastOccurred` string
    - `topErrorsError` string
  - `message` string
  - `requestId` string

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

[API](https://skmtc.dev/b3os/apis/b3os-workflow-api.md) · [All operations](https://skmtc.dev/b3os/apis/b3os-workflow-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/b3os/b3os-workflow-api/revisions/a8c7af3c66a1/schema)
