GET Freigegebene Arbeitsbereichsübersicht lesen
/api/v1/dashboard/summary
Passen Sie Ihr persönliches Dashboard direkt an: Verschieben Sie Karten, wählen Sie Quellen, legen Sie Titel und Breiten fest und ergänzen Sie Monitor-, Kennzahl-, Diagramm- oder Wartungskarten. Änderungen gelten erst nach dem Speichern und beachten immer den Gruppenfilter.
Auf dieser Seite
Zugriff und Rechte
Passen Sie Ihr persönliches Dashboard direkt an: Verschieben Sie Karten, wählen Sie Quellen, legen Sie Titel und Breiten fest und ergänzen Sie Monitor-, Kennzahl-, Diagramm- oder Wartungskarten. Änderungen gelten erst nach dem Speichern und beachten immer den Gruppenfilter.
Browsersitzung: Cookie __Host-mb_session.
Maschinen-Verwaltungszugang in Authorization: Bearer. Beachten Sie die von der Operation benötigten Berechtigungen (Scopes).
Parameter und Header
| Feld | Position | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|---|
| workspace_id | URL-Parameter | string; {"format":"uuid"} | Ja | UUID eines eigenen Arbeitsbereichs. Ist sie optional, wählt Weglassen den dokumentierten Standard oder alle eigenen Arbeitsbereiche. |
| group_id | URL-Parameter | string; {"pattern":"^(?:none|[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12})?$"} | Nein | Optionale Gruppen-UUID innerhalb des ausgewählten Arbeitsbereichs; none wählt Monitore ohne Gruppe. Ohne Parameter oder mit leerem Wert werden alle Gruppen erfasst. Zähler und sämtliche Übersichtslisten verwenden diesen Umfang. |
| range | URL-Parameter | string; {"enum":["24h","7d","30d"],"default":"24h"} | Nein | Dashboards gehören zu einem Arbeitsbereich. Eigentümer und Bearbeiter ändern gespeicherte Ansichten; Betrachter lesen sie. Grenzen: 10 aktive Dashboards je Arbeitsbereich, 20 Widgets je Dashboard und 4 numerische Reihen je Diagramm. Quellen müssen aktiv sein und demselben Arbeitsbereich angehören. Mutationen unterstützen Idempotency-Key; geänderte Nutzdaten mit demselben Schlüssel ergeben 409. PUT benötigt die aktuelle expected_revision. Größe und Reihenfolge sind feste Vorgaben. URL-Filter sind vorübergehend; gespeicherter Zeitraum und group_filter bleiben erhalten. |
| cards | URL-Parameter | string | Nein | Durch Kommas getrennte Kartenkennungen. Ohne Angabe wird die gesamte Übersicht geladen; nicht ausgewählte Karten laden ihre Detailvorschauen nicht. |
Anfragekörper
Kein Anfragekörper.
Antworten
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. |
| Content-Language | string; {"enum":["en","de"]} | Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. |
| Vary | string | Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | Der Browser muss den angegebenen Inhaltstyp verwenden. |
| X-Frame-Options | JSON; {"const":"DENY"} | Die Antwort darf nicht in einem Frame eingebettet werden. |
| X-Request-ID | string | Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen. |
application/json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | object; {"additionalProperties":true} | Ja | — |
| $.attention | array<object> | Nein | — |
| $.attention[] | object | Ja | — |
| $.attention[].http_code | string | null | Ja | — |
| $.attention[].http_code (anyOf 1) | string | Nein | — |
| $.attention[].http_code (anyOf 2) | null | Nein | — |
| $.attention[].http_status | string | null | Ja | — |
| $.attention[].http_status (anyOf 1) | string | Nein | — |
| $.attention[].http_status (anyOf 2) | null | Nein | — |
| $.attention[].id | string; {"format":"uuid"} | Ja | UUID dieser Ressource. Bewahren Sie die zurückgegebene Kennung für weitere Operationen auf. |
| $.attention[].monitor_type | string | Ja | — |
| $.attention[].name | string | Ja | Lesbarer Ressourcenname. Beachten Sie die angegebene Längengrenze. |
| $.attention[].reason | string; {"enum":["incident","http_down","quota","checker","heartbeat","check_down","check_paused"]} | Ja | Kurze Erklärung der gewählten Wartung oder Aufmerksamkeitssituation. |
| $.attention[].check_status | string; {"enum":["up","down","unknown","paused"]} | Nein | — |
| $.counts | object | Nein | — |
| $.counts.devices | integer; {"minimum":0} | Ja | — |
| $.counts.missing_heartbeats | integer; {"minimum":0} | Ja | — |
| $.counts.open_incidents | integer; {"minimum":0} | Ja | — |
| $.events | array<object> | Nein | — |
| $.events[] | object | Ja | — |
| $.events[].device_id | string; {"format":"uuid"} | Ja | UUID des Zielgeräts oder Monitors. Der Schreibschlüssel muss dieses Gerät erlauben. |
| $.events[].device_name | string | Ja | — |
| $.events[].id | string; {"format":"uuid"} | Ja | UUID dieser Ressource. Bewahren Sie die zurückgegebene Kennung für weitere Operationen auf. |
| $.events[].measured_at | string; {"format":"date-time"} | Ja | Vom Gerät gelieferter UTC-Messzeitpunkt; beachten Sie das zulässige Vergangenheits- und Zukunftsfenster. |
| $.events[].message | string | Ja | — |
| $.events[].severity | string; {"enum":["info","warning","critical"]} | Ja | Schweregrad aus dem angegebenen Wertebereich. |
| $.heartbeats | array<object> | Nein | — |
| $.heartbeats[] | object | Ja | — |
| $.heartbeats[].expected_heartbeat_seconds | integer; {"minimum":5} | Ja | Erwartetes Gerätekontaktintervall in Sekunden. |
| $.heartbeats[].id | string; {"format":"uuid"} | Ja | UUID dieser Ressource. Bewahren Sie die zurückgegebene Kennung für weitere Operationen auf. |
| $.heartbeats[].last_heartbeat_at | string; {"format":"date-time"} | null | Ja | Zeitpunkt des letzten angenommenen Gerätekontakts; null vor dem ersten Kontakt. |
| $.heartbeats[].last_heartbeat_at (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $.heartbeats[].last_heartbeat_at (anyOf 2) | null | Nein | — |
| $.heartbeats[].name | string | Ja | Lesbarer Ressourcenname. Beachten Sie die angegebene Längengrenze. |
| $.incidents | array<object> | Nein | — |
| $.incidents[] | object | Ja | — |
| $.incidents[].acknowledged_at | string; {"format":"date-time"} | null | Ja | Zeitpunkt ausdrücklicher Bestätigung; eine Bestätigung entwarnt die Bedingung nicht selbst. |
| $.incidents[].acknowledged_at (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $.incidents[].acknowledged_at (anyOf 2) | null | Nein | — |
| $.incidents[].device_id | string; {"format":"uuid"} | Ja | UUID des Zielgeräts oder Monitors. Der Schreibschlüssel muss dieses Gerät erlauben. |
| $.incidents[].device_name | string | Ja | — |
| $.incidents[].id | string; {"format":"uuid"} | Ja | UUID dieser Ressource. Bewahren Sie die zurückgegebene Kennung für weitere Operationen auf. |
| $.incidents[].opened_at | string; {"format":"date-time"} | Ja | Zeitpunkt der Eröffnung des Alarmvorfalls. |
| $.incidents[].rule_name | string | Ja | — |
| $.incidents[].severity | string; {"enum":["info","warning","critical"]} | Ja | Schweregrad aus dem angegebenen Wertebereich. |
| $.list_limit | integer | Nein | — |
| $.observed_at | string; {"format":"date-time"} | Ja | Serverzeitpunkt zur Bewertung der Aktualität dieser Antwort. |
| $.workspace_id | string | Ja | UUID des zugehörigen Arbeitsbereichs. Zugriff wird gegen das angemeldete Konto geprüft. |
| $.event_activity | array<object | object>; {"maxItems":20} | Nein | — |
| $.event_activity[] | object | object | Ja | — |
| $.event_activity[] (oneOf 1) | object | Nein | — |
| $.event_activity[] (oneOf 1).context | EventContext | Ja | Aufgelöste Quellenangaben. Ein Messreihenlink wird nur bei einer eindeutigen Reihe dieses Monitors geliefert. Fehlende historische Zustände werden nicht ergänzt. |
| $.event_activity[] (oneOf 1).context.series_id | string | null | Nein | — |
| $.event_activity[] (oneOf 1).context.series_name | string | null | Nein | — |
| $.event_activity[] (oneOf 1).context.series_kind | string | null | Nein | — |
| $.event_activity[] (oneOf 1).context.component_name | string | null | Nein | — |
| $.event_activity[] (oneOf 1).context.component_id | string | null | Nein | — |
| $.event_activity[] (oneOf 1).context.parameter_key | string | null | Nein | — |
| $.event_activity[] (oneOf 1).context.source | string | null | Nein | — |
| $.event_activity[] (oneOf 1).context.title_key | string | null | Nein | — |
| $.event_activity[] (oneOf 1).device_id | string; {"format":"uuid"} | Ja | UUID des Zielgeräts oder Monitors. Der Schreibschlüssel muss dieses Gerät erlauben. |
| $.event_activity[] (oneOf 1).device_name | string | Ja | — |
| $.event_activity[] (oneOf 1).id | string; {"format":"uuid"} | Ja | UUID dieser Ressource. Bewahren Sie die zurückgegebene Kennung für weitere Operationen auf. |
| $.event_activity[] (oneOf 1).kind | string; {"const":"event"} | Ja | — |
| $.event_activity[] (oneOf 1).labels | object | Ja | — |
| $.event_activity[] (oneOf 1).measured_at | string; {"format":"date-time"} | Ja | Vom Gerät gelieferter UTC-Messzeitpunkt; beachten Sie das zulässige Vergangenheits- und Zukunftsfenster. |
| $.event_activity[] (oneOf 1).message | string | Ja | — |
| $.event_activity[] (oneOf 1).severity | string; {"enum":["info","warning","critical"]} | Ja | Schweregrad aus dem angegebenen Wertebereich. |
| $.event_activity[] (oneOf 2) | object | Nein | — |
| $.event_activity[] (oneOf 2).count | integer; {"minimum":0} | Ja | — |
| $.event_activity[] (oneOf 2).first_at | string; {"format":"date-time"} | Ja | — |
| $.event_activity[] (oneOf 2).from | string; {"format":"date-time"} | Ja | — |
| $.event_activity[] (oneOf 2).id | string; {"format":"uuid"} | Ja | — |
| $.event_activity[] (oneOf 2).kind | string; {"const":"deployment"} | Ja | — |
| $.event_activity[] (oneOf 2).last_at | string; {"format":"date-time"} | Ja | — |
| $.event_activity[] (oneOf 2).measured_at | string; {"format":"date-time"} | Ja | — |
| $.event_activity[] (oneOf 2).service_count | integer; {"minimum":0} | Ja | — |
| $.event_activity[] (oneOf 2).severity_counts | object | Ja | — |
| $.event_activity[] (oneOf 2).severity_counts.info | integer; {"minimum":0} | Ja | — |
| $.event_activity[] (oneOf 2).severity_counts.warning | integer; {"minimum":0} | Ja | — |
| $.event_activity[] (oneOf 2).sources | array<object> | Ja | — |
| $.event_activity[] (oneOf 2).sources[] | object | Ja | — |
| $.event_activity[] (oneOf 2).sources[].component_id | string | Ja | — |
| $.event_activity[] (oneOf 2).sources[].component_name | string | Ja | — |
| $.event_activity[] (oneOf 2).sources[].count | integer; {"minimum":0} | Ja | — |
| $.event_activity[] (oneOf 2).sources[].device_id | string; {"format":"uuid"} | Ja | — |
| $.event_activity[] (oneOf 2).sources[].device_name | string | Ja | — |
| $.event_activity[] (oneOf 2).sources[].first_at | string; {"format":"date-time"} | Ja | — |
| $.event_activity[] (oneOf 2).sources[].last_at | string; {"format":"date-time"} | Ja | — |
| $.event_activity[] (oneOf 2).sources[].service | string | Ja | — |
| $.event_activity[] (oneOf 2).to | string; {"format":"date-time"} | Ja | — |
| $.monitoring | object; {"additionalProperties":true} | Nein | — |
| $.categories | object | Nein | — |
| $.servers | array<object; {"additionalProperties":true}> | Nein | — |
| $.servers[] | object; {"additionalProperties":true} | Ja | — |
| $.incident_severity | object | Nein | — |
| $.maintenance | object; {"additionalProperties":true} | Nein | — |
| $.status_pages | array<object; {"additionalProperties":true}> | Nein | — |
| $.status_pages[] | object; {"additionalProperties":true} | Ja | — |
| $.slos | array<object; {"additionalProperties":true}> | Nein | — |
| $.slos[] | object; {"additionalProperties":true} | Ja | — |
| $.setup | object | Nein | — |
{
"observed_at": "2026-09-30T12:00:00Z",
"workspace_id": "demo"
}| Stabile Fehlercodes |
|---|
| invalid_credential |
| unauthorized |
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. |
| Content-Language | string; {"enum":["en","de"]} | Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. |
| Vary | string | Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | Der Browser muss den angegebenen Inhaltstyp verwenden. |
| X-Frame-Options | JSON; {"const":"DENY"} | Die Antwort darf nicht in einem Frame eingebettet werden. |
| X-Request-ID | string | Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen. |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
{
"code": "demo",
"detail": "Demo error detail; inspect the documented code.",
"instance": "demo",
"message": "Demo error detail; inspect the documented code.",
"message_key": "errors.requestFailed",
"message_params": {},
"request_id": "00000000000000000000000000000000",
"status": 401,
"title": "Demo error",
"type": "about:blank"
}| Stabile Fehlercodes |
|---|
| csrf |
| forbidden |
| insufficient_scope |
| invalid_origin |
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. |
| Content-Language | string; {"enum":["en","de"]} | Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. |
| Vary | string | Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | Der Browser muss den angegebenen Inhaltstyp verwenden. |
| X-Frame-Options | JSON; {"const":"DENY"} | Die Antwort darf nicht in einem Frame eingebettet werden. |
| X-Request-ID | string | Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen. |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
{
"code": "demo",
"detail": "Demo error detail; inspect the documented code.",
"instance": "demo",
"message": "Demo error detail; inspect the documented code.",
"message_key": "errors.requestFailed",
"message_params": {},
"request_id": "00000000000000000000000000000000",
"status": 403,
"title": "Demo error",
"type": "about:blank"
}| Stabile Fehlercodes |
|---|
| not_found |
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. |
| Content-Language | string; {"enum":["en","de"]} | Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. |
| Vary | string | Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | Der Browser muss den angegebenen Inhaltstyp verwenden. |
| X-Frame-Options | JSON; {"const":"DENY"} | Die Antwort darf nicht in einem Frame eingebettet werden. |
| X-Request-ID | string | Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen. |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
{
"code": "demo",
"detail": "Demo error detail; inspect the documented code.",
"instance": "demo",
"message": "Demo error detail; inspect the documented code.",
"message_key": "errors.requestFailed",
"message_params": {},
"request_id": "00000000000000000000000000000000",
"status": 404,
"title": "Demo error",
"type": "about:blank"
}| Stabile Fehlercodes |
|---|
| invalid_workspace |
| invalid_group |
| invalid_time |
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. |
| Content-Language | string; {"enum":["en","de"]} | Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. |
| Vary | string | Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | Der Browser muss den angegebenen Inhaltstyp verwenden. |
| X-Frame-Options | JSON; {"const":"DENY"} | Die Antwort darf nicht in einem Frame eingebettet werden. |
| X-Request-ID | string | Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen. |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
{
"code": "demo",
"detail": "Demo error detail; inspect the documented code.",
"instance": "demo",
"message": "Demo error detail; inspect the documented code.",
"message_key": "errors.requestFailed",
"message_params": {},
"request_id": "00000000000000000000000000000000",
"status": 422,
"title": "Demo error",
"type": "about:blank"
}| Stabile Fehlercodes |
|---|
| unavailable |
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. |
| Content-Language | string; {"enum":["en","de"]} | Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. |
| Retry-After | string; {"pattern":"^[0-9]+$"} | Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation. |
| Vary | string | Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | Der Browser muss den angegebenen Inhaltstyp verwenden. |
| X-Frame-Options | JSON; {"const":"DENY"} | Die Antwort darf nicht in einem Frame eingebettet werden. |
| X-Request-ID | string | Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen. |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
{
"code": "demo",
"detail": "Demo error detail; inspect the documented code.",
"instance": "demo",
"message": "Demo error detail; inspect the documented code.",
"message_key": "errors.requestFailed",
"message_params": {},
"request_id": "00000000000000000000000000000000",
"status": 503,
"title": "Demo error",
"type": "about:blank"
}Wiederholungen und asynchrone Aufträge
Diese Operation liest oder prüft, ohne eine Ressourcenänderung anzuwenden. Beachten Sie Ratenlimits und Zugangslaufzeiten.
Anfragebeispiele
Ersetzen Sie Demokennungen, Zeitstempel und Platzhalter durch eigene Werte. Behalten Sie bei Wiederholungen Kennungen, Zeit und Inhalt bei. Diese Beispiele führen auf der Seite keine Anfragen aus.
Halten Sie Anmeldelinks, Codes, Cookies und Schlüssel privat. Schreiben Sie sie nicht in Logs und teilen Sie sie nicht in Hilfeanfragen.
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/dashboard/summary?workspace_id=00000000-0000-4000-8000-000000000001"
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())
request = Request("https://metribeacon.com/api/v1/dashboard/summary?workspace_id=00000000-0000-4000-8000-000000000001", data=None, headers=headers, method="GET")
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, request, fp, code, message, headers, target):
return None
opener = build_opener(NoRedirect())
try:
with opener.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/dashboard/summary?workspace_id=00000000-0000-4000-8000-000000000001", {
method: "GET", headers, redirect: "manual",
signal: AbortSignal.timeout(10000),
});
console.log(response.status);
await response.body?.cancel();
package main
import (
"fmt"
"net/http"
"time"
"encoding/json"
"os"
"path/filepath"
)
func main() {
home, err := os.UserHomeDir(); if err != nil { panic("request failed; credentials and response omitted") }
raw, err := os.ReadFile(filepath.Join(home, ".config/metribeacon/headers.json")); if err != nil { panic("request failed; credentials and response omitted") }
var headers map[string]string
if json.Unmarshal(raw, &headers) != nil { panic("invalid local headers") }
request, err := http.NewRequest("GET", "https://metribeacon.com/api/v1/dashboard/summary?workspace_id=00000000-0000-4000-8000-000000000001", nil)
if err != nil { panic("request failed; credentials and response omitted") }
for name, value := range headers { request.Header.Set(name, value) }
client := &http.Client{Timeout: 10*time.Second, CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse }}
response, err := client.Do(request)
if err != nil { panic("request failed; credentials and response omitted") }
defer response.Body.Close()
fmt.Println(response.StatusCode)
}
Verwandte Anleitungen
- HTTP-API, OAuth und MCP
Finden Sie die Nutzer-API-Endpunkte mit Rechten, Feldern, Beispielen und Antwortformaten.
- GET Gespeicherte Dashboard-Konfiguration lesen
Passen Sie Ihr persönliches Dashboard direkt an: Verschieben Sie Karten, wählen Sie Quellen, legen Sie Titel und Breiten fest und ergänzen Sie Monitor-, Kennzahl-, Diagramm- oder Wartungskarten. Änderungen gelten erst nach dem Speichern und beachten immer den Gruppenfilter.
- PUT Dashboard-Konfiguration atomar speichern
Passen Sie Ihr persönliches Dashboard direkt an: Verschieben Sie Karten, wählen Sie Quellen, legen Sie Titel und Breiten fest und ergänzen Sie Monitor-, Kennzahl-, Diagramm- oder Wartungskarten. Änderungen gelten erst nach dem Speichern und beachten immer den Gruppenfilter.
- POST Verfügbarkeit und Antwortzeit
Passen Sie Ihr persönliches Dashboard direkt an: Verschieben Sie Karten, wählen Sie Quellen, legen Sie Titel und Breiten fest und ergänzen Sie Monitor-, Kennzahl-, Diagramm- oder Wartungskarten. Änderungen gelten erst nach dem Speichern und beachten immer den Gruppenfilter.