# Get the health advisor report — API reference

> Returns findings, severity counts and the evaluated scope.

Source: https://upfour.io/docs/api/advisor/get-the-health-advisor-report

[Developers](https://upfour.io/docs/api.md)/[Health advisor](https://upfour.io/docs/api/advisor.md)

Returns findings, severity counts and the evaluated scope.

GET https://app.upfour.io/v1/advisor

scope report.read stable returns 200

## Parameters

| Field | Type | Description |
| --- | --- | --- |
| `limit` optional | integer 1–250 default `50` | query parameter |
| `cursor` optional | string | query parameter |
| `client_id` optional | uuid | query parameter |
| `all_clients` optional | boolean | query parameter |
| `q` optional | string | query parameter |
| `sort` optional | string | query parameter |

## Returns

A successful request returns `200` with application/json.

Response fields 1 top-level fields

| Field | Type | Description |
| --- | --- | --- |
| `data` | AdvisorReport | |
| AdvisorReport · 19 fields FieldTypeDescription `critical_count` integer `findings` AdvisorFinding[]  · nullable Each item · 12 fields FieldTypeDescription `rule_id` string Identifier of the rule, e.g. monitor_without_recipient, interval_below_plan_minimum, ssl_expiring_soon, single_region. New rules can appear. `severity` string one of`critical` `warning` `hint` `target_type` string one of`monitor` `channel` `escalation_policy` `heartbeat` `organization` `title` string `why` string `fix_action` string attach_default_channel or set_interval when POST /advisor/apply can fix the finding; absent for advice that only links to fix_href. `fix_href` string `fix_label` string `message_params` object free-form keys Values for localizing the finding's prose; the keys depend on the rule. `message_variant` string `target_id` uuid `target_name` string `generated_at` string (date-time) `hint_count` integer `monitors_with_findings` map of string  · nullable one of`critical` `warning` `hint` Highest severity per monitor ID with findings. `scope` string one of`organization` `monitor` `warning_count` integer | | |

## Errors

Only the errors this operation can return. Every error uses the [same envelope](https://upfour.io/docs/api/responses.md).

| Status | Code | Meaning |
| --- | --- | --- |
| 400 | [bad_request](https://upfour.io/docs/api/errors#code-bad_request) | The request is malformed or fails validation. |

Every call can also return `unauthorized` (401), `rate_limit_exceeded` (429) or `internal_error` (500 / 502). See [Responses and errors](https://upfour.io/docs/api/responses.md).

[NextApply an advisor fix](https://upfour.io/docs/api/advisor/apply-an-advisor-fix.md)

## Request

### cURL

```bash
curl -s "https://app.upfour.io/v1/advisor" \
  -H "Authorization: Bearer $UP4_API_KEY"
```

### JavaScript

```javascript
const res = await fetch("https://app.upfour.io/v1/advisor", {
  headers: {
    Authorization: `Bearer ${process.env.UP4_API_KEY}`,
  },
});
console.log(res.status, await res.json());
```

### Python

```python
import os
import requests

res = requests.get(
    "https://app.upfour.io/v1/advisor",
    headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"},
)
print(res.status_code, res.json())
```

### Go

```go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://app.upfour.io/v1/advisor", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}
```

### PHP

```php
<?php
$ch = curl_init("https://app.upfour.io/v1/advisor");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("UP4_API_KEY"),
    ],
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n";
curl_close($ch);
```

## Response

### 200

```json
{
  "data": {
    "critical_count": 3,
    "findings": [
      {
        "fix_action": "attach_default_channel",
        "fix_href": "/monitors/00000000-0000-4000-8000-000000000001/edit",
        "fix_label": "Alert me by email",
        "rule_id": "monitor_without_recipient",
        "severity": "critical",
        "target_id": "00000000-0000-4000-8000-000000000001",
        "target_name": "Status page",
        "target_type": "monitor",
        "title": "Nobody is alerted when this goes down",
        "why": "This monitor has no alert channel and no alert plan. If it fails, up4 checks it, records the outage — and tells no one."
      },
      {
        "fix_action": "attach_default_channel",
        "fix_href": "/monitors/00000000-0000-4000-8000-000000000002/edit",
        "fix_label": "Alert me by email",
        "rule_id": "monitor_without_recipient",
        "severity": "critical",
        "target_id": "00000000-0000-4000-8000-000000000002",
        "target_name": "Docs site",
        "target_type": "monitor",
        "title": "Nobody is alerted when this goes down",
        "why": "This monitor has no alert channel and no alert plan. If it fails, up4 checks it, records the outage — and tells no one."
      },
      {
        "fix_action": "attach_default_channel",
        "fix_href": "/monitors/00000000-0000-4000-8000-000000000003/edit",
        "fix_label": "Alert me by email",
        "rule_id": "monitor_without_recipient",
        "severity": "critical",
        "target_id": "00000000-0000-4000-8000-000000000003",
        "target_name": "Marketing website",
        "target_type": "monitor",
        "title": "Nobody is alerted when this goes down",
        "why": "This monitor has no alert channel and no alert plan. If it fails, up4 checks it, records the outage — and tells no one."
      },
      {
        "fix_href": "/escalation-policies/00000000-0000-4000-8000-000000000004",
        "fix_label": "Attach to monitors",
        "rule_id": "alert_plan_without_monitors",
        "severity": "hint",
        "target_id": "00000000-0000-4000-8000-000000000004",
        "target_name": "Default escalation",
        "target_type": "escalation_policy",
        "title": "This alert plan is not attached to anything",
        "why": "No monitor uses this plan, so its escalation steps never run."
      }
    ],
    "generated_at": "2026-10-27T09:00:00Z",
    "hint_count": 1,
    "monitors_with_findings": {
      "00000000-0000-4000-8000-000000000001": "critical",
      "00000000-0000-4000-8000-000000000002": "critical",
      "00000000-0000-4000-8000-000000000003": "critical"
    },
    "scope": "organization",
    "warning_count": 0
  }
}
```

### 400

```json
{
  "error": {
    "code": "bad_request",
    "message": "The request is malformed or fails validation.",
    "request_id": "req_…"
  }
}
```
