GET List report schedules
/api/v1/workspaces/{id}/report-schedules
Workspace SLOs use the aggregate availability series of HTTP, TCP, UDP, DNS, TLS, ping, service, domain and browser monitors. Unknown and unobserved time remain explicit; satisfaction is only proven by the lower availability bound. Ten SLOs and three report schedules are allowed per workspace. Calendar reports are immutable for 90 days. Email requires explicit owner opt-in and a verified destination, and shares the existing notification quota. Asynchronous jobs share four global slots and one per owner, can be cancelled and cannot cross workspace boundaries. Choose daily, weekly or monthly reports and a dispatch time (HH:MM) in an IANA timezone. Reports cover the previous local calendar day, Monday–Sunday week or month. Processing starts at that time; delivery may be later. During daylight-saving changes, a missing time moves to the next valid minute and a repeated time runs only once. Manual generation uses the last closed period regardless of the dispatch time.
On this page
Access and permissions
Workspace SLOs use the aggregate availability series of HTTP, TCP, UDP, DNS, TLS, ping, service, domain and browser monitors. Unknown and unobserved time remain explicit; satisfaction is only proven by the lower availability bound. Ten SLOs and three report schedules are allowed per workspace. Calendar reports are immutable for 90 days. Email requires explicit owner opt-in and a verified destination, and shares the existing notification quota. Asynchronous jobs share four global slots and one per owner, can be cancelled and cannot cross workspace boundaries. Choose daily, weekly or monthly reports and a dispatch time (HH:MM) in an IANA timezone. Reports cover the previous local calendar day, Monday–Sunday week or month. Processing starts at that time; delivery may be later. During daylight-saving changes, a missing time moves to the next valid minute and a repeated time runs only once. Manual generation uses the last closed period regardless of the dispatch time.
Browser session: __Host-mb_session cookie.
Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.
Parameters and headers
| Field | Location | Type and limits | Required | Meaning |
|---|---|---|---|---|
| id | Path | string; {"format":"uuid"} | Yes | Resource ID in this workspace |
Request body
No request body.
Responses
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object | Yes | — |
| $.limit | integer | Yes | — |
| $.schedules | array<object> | Yes | — |
| $.schedules[] | object | Yes | — |
| $.schedules[].cadence | string; {"enum":["daily","weekly","monthly"]} | Yes | — |
| $.schedules[].destination_id | string | null | Yes | — |
| $.schedules[].destination_id (anyOf 1) | string | No | — |
| $.schedules[].destination_id (anyOf 2) | null | No | — |
| $.schedules[].email_opt_in | boolean | Yes | — |
| $.schedules[].enabled | boolean | Yes | — |
| $.schedules[].id | string | Yes | — |
| $.schedules[].language | string | Yes | — |
| $.schedules[].name | string | Yes | — |
| $.schedules[].next_due | string; {"format":"date-time"} | Yes | — |
| $.schedules[].revision | integer | Yes | — |
| $.schedules[].timezone | string | Yes | — |
| $.schedules[].workspace_id | string | Yes | — |
| $.schedules[].local_time | string; {"pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]$"} | Yes | — |
| $.schedules[].report_definition | ReportingDefinition | null | No | — |
| $.schedules[].report_definition (anyOf 1) | ReportingDefinition | No | — |
| $.schedules[].report_definition (anyOf 1).adjusted | boolean | No | — |
| $.schedules[].report_definition (anyOf 1).chart_sources | array<string; {"maxLength":200}>; {"maxItems":8} | No | — |
| $.schedules[].report_definition (anyOf 1).chart_sources[] | string; {"maxLength":200} | Yes | — |
| $.schedules[].report_definition (anyOf 1).filters | ReportingFilters | Yes | — |
| $.schedules[].report_definition (anyOf 1).filters.channel | string; {"enum":["","email","telegram","discord","slack","ntfy","webhook","webpush"]} | No | — |
| $.schedules[].report_definition (anyOf 1).filters.filesystem | string; {"maxLength":512} | No | — |
| $.schedules[].report_definition (anyOf 1).filters.group_ids | array<string; {"format":"uuid"}>; {"maxItems":1000} | No | — |
| $.schedules[].report_definition (anyOf 1).filters.group_ids[] | string; {"format":"uuid"} | Yes | — |
| $.schedules[].report_definition (anyOf 1).filters.location_ids | array<string; {"format":"uuid"}>; {"maxItems":1000} | No | — |
| $.schedules[].report_definition (anyOf 1).filters.location_ids[] | string; {"format":"uuid"} | Yes | — |
| $.schedules[].report_definition (anyOf 1).filters.monitor_ids | array<string; {"format":"uuid"}>; {"maxItems":1000} | No | — |
| $.schedules[].report_definition (anyOf 1).filters.monitor_ids[] | string; {"format":"uuid"} | Yes | — |
| $.schedules[].report_definition (anyOf 1).filters.resource | string; {"enum":["","cpu","memory","filesystem","disk","network"]} | No | — |
| $.schedules[].report_definition (anyOf 1).filters.severity | string; {"enum":["","info","warning","critical"]} | No | — |
| $.schedules[].report_definition (anyOf 1).filters.types | array<string; {"maxLength":32}>; {"maxItems":1000} | No | — |
| $.schedules[].report_definition (anyOf 1).filters.types[] | string; {"maxLength":32} | Yes | — |
| $.schedules[].report_definition (anyOf 1).granularity | string; {"enum":["hour","day","week","month"]} | Yes | — |
| $.schedules[].report_definition (anyOf 1).language | string; {"enum":["en","de"]} | No | — |
| $.schedules[].report_definition (anyOf 1).sections | array<string; {"enum":["overview","availability","incidents","mttr","mtta","response","maintenance","notifications","certificates","jobs","resources"]}>; {"maxItems":11,"minItems":1} | Yes | — |
| $.schedules[].report_definition (anyOf 1).sections[] | string; {"enum":["overview","availability","incidents","mttr","mtta","response","maintenance","notifications","certificates","jobs","resources"]} | Yes | — |
| $.schedules[].report_definition (anyOf 1).timezone | string; {"maxLength":64} | Yes | — |
| $.schedules[].report_definition (anyOf 1).version | integer; {"const":1} | No | — |
| $.schedules[].report_definition (anyOf 2) | null | No | — |
| Stable error codes |
|---|
| invalid_session |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| csrf |
| forbidden |
| insufficient_scope |
| owner_required |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| not_found |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| idempotency_conflict |
| job_not_active |
| job_not_ready |
| revision_conflict |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| invalid_idempotency_key |
| invalid_report |
| invalid_slo |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| alarm_limit |
| analysis_capacity |
| report_limit |
| slo_limit |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| unavailable |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
Retries and asynchronous work
This operation reads or validates without applying a resource mutation. Respect rate limits and credential lifetime.
Request examples
Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.
Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.
curl --silent --show-error --output /dev/null --write-out "%{http_code}\n" --request GET --header @"$HOME/.config/metribeacon/headers.txt" "https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/report-schedules"
import json
from pathlib import Path
from urllib.request import Request, HTTPRedirectHandler, build_opener
from urllib.error import HTTPError
headers=json.loads((Path.home()/".config/metribeacon/headers.json").read_text())
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, request, fp, code, message, headers, target): return None
request=Request('https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/report-schedules',data=None,headers=headers,method='GET')
try:
with build_opener(NoRedirect()).open(request,timeout=10) as response: print(response.status)
except HTTPError as error:
print(error.code)
error.close()
import {readFile} from "node:fs/promises";
import {homedir} from "node:os";
import {join} from "node:path";
const headers=JSON.parse(await readFile(join(homedir(),".config/metribeacon/headers.json"),"utf8"));
const response=await fetch("https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/report-schedules",{method:"GET",headers,redirect:"manual",signal:AbortSignal.timeout(10000)});
console.log(response.status);await response.body?.cancel();
package main
import("encoding/json";"fmt";"net/http";"os";"path/filepath";"time")
func main(){home,e:=os.UserHomeDir();if e!=nil{return};raw,e:=os.ReadFile(filepath.Join(home,".config/metribeacon/headers.json"));if e!=nil{return};var headers map[string]string;if json.Unmarshal(raw,&headers)!=nil{return};req,e:=http.NewRequest("GET","https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/report-schedules",nil);if e!=nil{return};for k,v:=range headers{req.Header.Set(k,v)};client:=&http.Client{Timeout:10*time.Second,CheckRedirect:func(*http.Request,[]*http.Request)error{return http.ErrUseLastResponse}};res,e:=client.Do(req);if e!=nil{return};defer res.Body.Close();fmt.Println(res.StatusCode)}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- POST Create a report schedule
Workspace SLOs use the aggregate availability series of HTTP, TCP, UDP, DNS, TLS, ping, service, domain and browser monitors. Unknown and unobserved time remain explicit; satisfaction is only proven by the lower availability bound. Ten SLOs and three report schedules are allowed per workspace. Calendar reports are immutable for 90 days. Email requires explicit owner opt-in and a verified destination, and shares the existing notification quota. Asynchronous jobs share four global slots and one per owner, can be cancelled and cannot cross workspace boundaries. Choose daily, weekly or monthly reports and a dispatch time (HH:MM) in an IANA timezone. Reports cover the previous local calendar day, Monday–Sunday week or month. Processing starts at that time; delivery may be later. During daylight-saving changes, a missing time moves to the next valid minute and a repeated time runs only once. Manual generation uses the last closed period regardless of the dispatch time.
- GET List immutable workspace reports
Workspace SLOs use the aggregate availability series of HTTP, TCP, UDP, DNS, TLS, ping, service, domain and browser monitors. Unknown and unobserved time remain explicit; satisfaction is only proven by the lower availability bound. Ten SLOs and three report schedules are allowed per workspace. Calendar reports are immutable for 90 days. Email requires explicit owner opt-in and a verified destination, and shares the existing notification quota. Asynchronous jobs share four global slots and one per owner, can be cancelled and cannot cross workspace boundaries. Choose daily, weekly or monthly reports and a dispatch time (HH:MM) in an IANA timezone. Reports cover the previous local calendar day, Monday–Sunday week or month. Processing starts at that time; delivery may be later. During daylight-saving changes, a missing time moves to the next valid minute and a repeated time runs only once. Manual generation uses the last closed period regardless of the dispatch time.
- GET List workspace SLOs
Workspace SLOs use the aggregate availability series of HTTP, TCP, UDP, DNS, TLS, ping, service, domain and browser monitors. Unknown and unobserved time remain explicit; satisfaction is only proven by the lower availability bound. Ten SLOs and three report schedules are allowed per workspace. Calendar reports are immutable for 90 days. Email requires explicit owner opt-in and a verified destination, and shares the existing notification quota. Asynchronous jobs share four global slots and one per owner, can be cancelled and cannot cross workspace boundaries. Choose daily, weekly or monthly reports and a dispatch time (HH:MM) in an IANA timezone. Reports cover the previous local calendar day, Monday–Sunday week or month. Processing starts at that time; delivery may be later. During daylight-saving changes, a missing time moves to the next valid minute and a repeated time runs only once. Manual generation uses the last closed period regardless of the dispatch time.