> ## Documentation Index > Fetch the complete documentation index at: https://docs.mezmo.com/llms.txt > Use this file to discover all available pages before exploring further. # Summarize pipeline health for one or more pipelines > Returns overall ingestion health as well as pipeline-specific health, such as lag in a pipeline's sources. ## OpenAPI ````yaml /pipeline.yaml get /pipeline/health openapi: 3.1.0 info: title: Pipeline API description: API for the Pipeline product version: 3.345.5 servers: - url: https://api.mezmo.com/v3 security: - PipelineServiceKey: [] tags: - name: Internal description: Routes not accessible by outside users - name: Experimental description: Experimental routes, not intended for public consumption - name: Account description: Perform account level actions - name: Alerting description: API to control alerts on pipelines - name: Data Classification & Profiling description: API for classifying and profiling data - name: Edge - Local Deploy description: User routes that are available to use with local Edge instances - name: Incident Mode description: Change or read state of pipeline (incident mode on/off) - name: Log Volume Reduction description: CRUD operations for log volume reduction - name: Metrics description: Usage metrics for pipelines - name: Pipeline Export description: Export pipeline to terraform - name: Pipeline Management description: CRUD Operations for pipeline - name: Pipeline Nodes description: CRUD operations for sources, processors, and destinations - name: Processor Groups description: CRUD operations for Processor Groups - name: Shared Sources description: Create and manage sources for use across multiple pipelines - name: Sampling and Simulation description: >- Create samples of data and run them through a simulated pipeline without affecting your published pipeline externalDocs: url: https://docs.mezmo.com/pipeline-api paths: /pipeline/health: get: tags: - Pipeline Management summary: Summarize pipeline health for one or more pipelines description: >- Returns overall ingestion health as well as pipeline-specific health, such as lag in a pipeline's sources. parameters: - schema: type: integer minimum: 1 maximum: 60 default: 15 in: query name: interval_minutes required: false description: The window interval for measuring ingestion volume - schema: type: array items: type: string format: uuid description: A pipeline id in: query name: pipeline_ids required: false description: Return only pipelines with the given IDs responses: '200': description: Default Response content: application/json: schema: type: object properties: meta: type: object additionalProperties: true data: type: object description: Overall health of data ingestion and pipeline sources properties: interval_minutes: type: integer description: The window interval for measuring ingestion volume ingestion_health: type: object properties: ingestion_metrics_status: type: string description: >- A success or failure message for the ability to fetch metrics related to ingestion routes routes: type: array description: Ingestion status code health metrics per route items: type: object properties: route: type: string description: The route path health: type: array description: >- The health of a specific route measured by changes in status code items: type: object properties: status_code: type: integer description: The HTTP status code change_percent: type: number description: >- 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: type: object properties: lag_metrics_status: type: string description: >- A success or failure message for the ability to fetch lag metrics pipelines: type: array description: >- All active and published pipelines. Inactive or unpublished pipelines are not included. items: type: object properties: id: type: string format: uuid description: The pipeline id title: type: string description: The pipeline title published_at: type: string format: date-time description: >- The date/time of the pipeline's last publish (if at all) sources: type: array description: Sources associated with this pipeline items: type: object properties: id: type: string description: >- The source id, which can also be the consumer group id type: type: string description: The type of source component title: type: string description: The title of the source component is_consumer_group: type: boolean description: >- Whether this source is a consumer group that could have lag lag_event_count: anyOf: - type: number description: >- 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`) - type: 'null' components: securitySchemes: PipelineServiceKey: type: apiKey name: Authorization in: header description: 'Enter your token in the format: Token mytokengoeshere' ````