Skip to main content
GET
/
pipeline
/
health
Summarize pipeline health for one or more pipelines
curl --request GET \
  --url https://api.mezmo.com/v3/pipeline/health \
  --header 'Authorization: <api-key>'
{
  "meta": {},
  "data": {
    "interval_minutes": 123,
    "ingestion_health": {
      "ingestion_metrics_status": "<string>",
      "routes": [
        {
          "route": "<string>",
          "health": [
            {
              "status_code": 123,
              "change_percent": 123
            }
          ]
        }
      ]
    },
    "pipeline_health": {
      "lag_metrics_status": "<string>",
      "pipelines": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "published_at": "2023-11-07T05:31:56Z",
          "sources": [
            {
              "id": "<string>",
              "type": "<string>",
              "title": "<string>",
              "is_consumer_group": true,
              "lag_event_count": 123
            }
          ]
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://mezmo-9a59581a-mintlify-926f893d.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Enter your token in the format: Token mytokengoeshere

Query Parameters

​
interval_minutes
integer
default:15

The window interval for measuring ingestion volume

Required range: 1 <= x <= 60
​
pipeline_ids
string<uuid>[]

Return only pipelines with the given IDs

A pipeline id

Response

200 - application/json

Default Response

​
meta
object
​
data
object

Overall health of data ingestion and pipeline sources