# Get the monitor ribbon — API reference

> Returns monitor lanes with state, check totals, uptime percentages and the selected time window.

Source: https://upfour.io/docs/api/reports/get-the-monitor-ribbon

[Developers](https://upfour.io/docs/api.md)/[Reports](https://upfour.io/docs/api/reports.md)

Returns monitor lanes with state, check totals, uptime percentages and the selected time window.

GET https://app.upfour.io/v1/reports/monitor-ribbon

scope report.read stable returns 200

## Returns

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

Response fields 1 top-level fields

| Field | Type | Description |
| --- | --- | --- |
| `data` | ReportMonitorRibbon | |
| ReportMonitorRibbon · 14 fields FieldTypeDescription `monitors` ReportMonitorRibbonLane[]  · nullable Each item · 10 fields FieldTypeDescription `checks_total` integer `id` uuid `name` string `segments` ReportRibbonSegment[]  · nullable Each item · 4 fields FieldTypeDescription `end` string (date-time) `start` string (date-time) `state` string one of`down` `degraded` `monitor_name` string `state` string one of`UP` `DOWN` `PAUSED` `PENDING` `uptime_pct` number  · nullable null when the window holds no checks. `window` string one of`6h` `24h` `7d` `30d` `window_end` string (date-time) `window_start` string (date-time) | | |

## 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. |
| 403 | [permission_denied](https://upfour.io/docs/api/errors#code-permission_denied) | The credentials do not permit this action. |

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).

[PreviousGet report trends](https://upfour.io/docs/api/reports/get-report-trends.md) [NextGet the agency ribbon](https://upfour.io/docs/api/reports/get-the-agency-ribbon.md)

## Request

### cURL

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

### JavaScript

```javascript
const res = await fetch("https://app.upfour.io/v1/reports/monitor-ribbon", {
  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/reports/monitor-ribbon",
    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/reports/monitor-ribbon", 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/reports/monitor-ribbon");
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": {
    "monitors": [
      {
        "checks_total": 6,
        "id": "00000000-0000-4000-8000-000000000001",
        "name": "Marketing website",
        "segments": [],
        "state": "UP",
        "uptime_pct": 100
      },
      {
        "checks_total": 0,
        "id": "00000000-0000-4000-8000-000000000002",
        "name": "Docs site",
        "segments": [],
        "state": "PENDING",
        "uptime_pct": null
      },
      {
        "checks_total": 0,
        "id": "00000000-0000-4000-8000-000000000003",
        "name": "Status page",
        "segments": [],
        "state": "PENDING",
        "uptime_pct": null
      }
    ],
    "window": "24h",
    "window_end": "2026-10-27T09:00:00Z",
    "window_start": "2026-10-26T09:00:00Z"
  }
}
```

### 400

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

### 403

```json
{
  "error": {
    "code": "permission_denied",
    "message": "The credentials do not permit this action.",
    "request_id": "req_…"
  }
}
```