---
title: "Summarize pipeline health for one or more pipelines"
method: GET
path: "/pipeline/health"
tags: ["Pipeline Management"]
---

# Summarize pipeline health for one or more pipelines

`GET /pipeline/health`

## Request

- Base URL: `https://api.mezmo.com/v3`
- URL: `https://api.mezmo.com/v3/pipeline/health`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/mezmo/apis/pipeline-api/docs/pipeline/health/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns overall ingestion health as well as pipeline-specific health, such as lag in a pipeline's sources.

## Query parameters

- `interval_minutes` integer
- `pipeline_ids` string[]

## Response `200`

Default Response

- object
  - `meta` object
  - `data` object: Overall health of data ingestion and pipeline sources
    - `interval_minutes` integer: The window interval for measuring ingestion volume
    - `ingestion_health` object
      - `ingestion_metrics_status` string: A success or failure message for the ability to fetch metrics related to ingestion routes
      - `routes` object[]: Ingestion status code health metrics per route
        - `route` string: The route path
        - `health` object[]: The health of a specific route measured by changes in status code
          - `status_code` integer: The HTTP status code
          - `change_percent` number: The percentage change for the status code over time. The result is a comparison of the current interval and the same interval offset by `interval_minutes` ago. For example, when `{interval_minutes: 5, offset_minutes: 5}`, that calculates the percentage change in a 5-minute window from 5 minutes ago to a 5-minute window 10 minutes ago.
    - `pipeline_health` object
      - `lag_metrics_status` string: A success or failure message for the ability to fetch lag metrics
      - `pipelines` object[]: All active and published pipelines. Inactive or unpublished pipelines are not included.
        - `id` string, uuid: The pipeline id
        - `title` string: The pipeline title
        - `published_at` string, date-time: The date/time of the pipeline's last publish (if at all)
        - `sources` object[]: Sources associated with this pipeline
          - `id` string: The source id, which can also be the consumer group id
          - `type` string: The type of source component
          - `title` string: The title of the source component
          - `is_consumer_group` boolean: Whether this source is a consumer group that could have lag
          - `lag_event_count` number, nullable: The number of events lagging behind. If this value is `null`, then it could mean the source has never had consumers, or that the lag metrics were unavailable (check `lag_metrics_status`)

---

[API](https://skmtc.dev/mezmo/apis/pipeline-api.md) - [All operations](https://skmtc.dev/mezmo/apis/pipeline-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mezmo/apis/pipeline-api/revisions/fb2535545d90?raw)