> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://mezmo.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mezmo.ferndocs.com/_mcp/server.

# Fetch pipeline health metrics

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

Query and fetch health information for the current account.

Reference: https://mezmo.ferndocs.com/api-reference/pipeline/metrics/fetch-pipeline-health-metrics

## Authentication

- `Authorization` header (required) (prefixed with ` Token  `) — Header authentication of the form `Token <token>`

## Request

### Query parameters

- `pipeline_id` (string, optional) — Limit health metrics to the given pipeline id. If not defined, the metrics will include all pipelines for the account.
- `include_logs` (boolean, optional, default: true) — Fetch previous log messages for transforms.

## Response

### 200

Default Response

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "pipelines": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "payment-service",
      "status": "healthy",
      "metrics": {
        "request_latency_ms": 120,
        "error_rate_5xx": 0.02,
        "throughput_rps": 350
      },
      "logs": [
        {
          "timestamp": "2024-06-10T14:22:35Z",
          "level": "INFO",
          "message": "Processed batch 42 successfully",
          "host": "logs.acme-corp.io"
        },
        {
          "timestamp": "2024-06-10T14:23:01Z",
          "level": "WARN",
          "message": "Retrying failed request to auth-gateway",
          "host": "logs.acme-corp.io"
        }
      ]
    },
    {
      "id": "7b9e1f2a-8c4d-4d3a-9f1e-2a7b8c9d0e1f",
      "name": "order-processor",
      "status": "degraded",
      "metrics": {
        "request_latency_ms": 250,
        "error_rate_5xx": 0.1,
        "throughput_rps": 180
      },
      "logs": [
        {
          "timestamp": "2024-06-10T14:21:10Z",
          "level": "ERROR",
          "message": "Failed to connect to telemetry.acme-corp.io",
          "host": "logs.acme-corp.io"
        },
        {
          "timestamp": "2024-06-10T14:22:45Z",
          "level": "INFO",
          "message": "Recovered connection to telemetry.acme-corp.io",
          "host": "logs.acme-corp.io"
        }
      ]
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.mezmo.com/v3/pipeline/metric/health"

querystring = {"pipeline_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","include_logs":"true"}

payload = {}
headers = {
    "Authorization": "Token <pipeline-service-key>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.mezmo.com/v3/pipeline/metric/health?pipeline_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&include_logs=true';
const options = {
  method: 'GET',
  headers: {
    Authorization: 'Token <pipeline-service-key>',
    'Content-Type': 'application/json'
  },
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mezmo.com/v3/pipeline/metric/health?pipeline_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&include_logs=true"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Token <pipeline-service-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.mezmo.com/v3/pipeline/metric/health?pipeline_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&include_logs=true")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Token <pipeline-service-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.mezmo.com/v3/pipeline/metric/health?pipeline_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&include_logs=true")
  .header("Authorization", "Token <pipeline-service-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.mezmo.com/v3/pipeline/metric/health?pipeline_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&include_logs=true', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Token <pipeline-service-key>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.mezmo.com/v3/pipeline/metric/health?pipeline_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&include_logs=true");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Token <pipeline-service-key>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Token <pipeline-service-key>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.mezmo.com/v3/pipeline/metric/health?pipeline_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&include_logs=true")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```