Summarize pipeline health for one or more pipelines

GET

https://api.mezmo.com/v3/pipeline/health

GET

/v3/pipeline/health

curl https://api.mezmo.com/v3/pipeline/health \
     -H "Authorization: Token <pipeline-service-key>" \
     -H "Content-Type: application/json"

200Retrieved

{
  "meta": {},
  "data": {
    "interval_minutes": 5,
    "ingestion_health": {
      "ingestion_metrics_status": "Metrics fetched successfully",
      "routes": [
        {
          "route": "/api/v1/logs",
          "health": [
            {
              "status_code": 200,
              "change_percent": -3.5
            },
            {
              "status_code": 500,
              "change_percent": 12.7
            }
          ]
        },
        {
          "route": "/api/v1/metrics",
          "health": [
            {
              "status_code": 200,
              "change_percent": 0
            },
            {
              "status_code": 429,
              "change_percent": 5.2
            }
          ]
        }
      ]
    },
    "pipeline_health": {
      "lag_metrics_status": "Lag metrics up to date",
      "pipelines": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "payment-service-ingestion",
          "published_at": "2024-04-20T14:45:00Z",
          "sources": [
            {
              "id": "consumer-group-01",
              "type": "kafka-consumer",
              "title": "payment-service-kafka-group",
              "is_consumer_group": true,
              "lag_event_count": 120
            },
            {
              "id": "source-logs-acme",
              "type": "http-source",
              "title": "logs.acme-corp.io",
              "is_consumer_group": false,
              "lag_event_count": null
            }
          ]
        },
        {
          "id": "7b9e1f2a-8c3d-4f9a-9f1e-2d4a5b6c7d8e",
          "title": "auth-gateway-pipeline",
          "published_at": "2024-04-18T08:30:00Z",
          "sources": [
            {
              "id": "consumer-group-auth",
              "type": "kafka-consumer",
              "title": "auth-gateway-kafka-group",
              "is_consumer_group": true,
              "lag_event_count": 0
            }
          ]
        }
      ]
    }
  }
}

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

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Query parameters

interval_minutesintegerOptional1-60Defaults to 15

The window interval for measuring ingestion volume

pipeline_idslist of stringsOptional

Return only pipelines with the given IDs

Response

Default Response

metamap from strings to anyOptional

dataobjectOptional

Overall health of data ingestion and pipeline sources