GET Read personal summary metrics

/api/v1/devices/{id}/summary-metrics

Choose one to four ordered summary values or configured series for your personal view of this monitor. Lists show all choices; dashboard cards show the first three. Viewer access is sufficient. This does not change collection or shared monitor settings. GET searches configured series by name with q (up to 128 characters), returning up to 50 series per page plus summary options on the first page; next_cursor continues the page. Stable references use summary:, check: or series:. Missing or disabled saved sources retain an unavailable slot. PUT and DELETE require expected_revision and Idempotency-Key; conflicts return 409. DELETE restores automatic choices. Browser sessions only.

On this page

Access and permissions

Choose one to four ordered summary values or configured series for your personal view of this monitor. Lists show all choices; dashboard cards show the first three. Viewer access is sufficient. This does not change collection or shared monitor settings. GET searches configured series by name with q (up to 128 characters), returning up to 50 series per page plus summary options on the first page; next_cursor continues the page. Stable references use summary:, check: or series:. Missing or disabled saved sources retain an unavailable slot. PUT and DELETE require expected_revision and Idempotency-Key; conflicts return 409. DELETE restores automatic choices. Browser sessions only.

Browser session: __Host-mb_session cookie.

Parameters and headers

FieldLocationType and limitsRequiredMeaning
idPathstring; {"format":"uuid"}YesResource UUID from the path. It must exist and be accessible to the acting identity.
qURL querystring; {"maxLength":128}NoSearch configured measurement names; summary labels are filtered in the interface.
cursorURL querystring; {"format":"uuid"}NoOpaque series cursor from next_cursor; omit for the first page.

Request body

No request body.

Responses

application/json

FieldType and limitsRequiredMeaning
$object; {"additionalProperties":false}Yes—
$.revisioninteger; {"minimum":0}Yes—
$.custombooleanYes—
$.selectionarray<object; {"additionalProperties":true}>; {"maxItems":4}Yes—
$.selection[]object; {"additionalProperties":true}Yes—
$.selection[].refstringYes—
$.selection[].keystringYes—
$.selection[].namestringNo—
$.selection[].unitstringYes—
$.selection[].valuenumber | string | nullYes—
$.selection[].freshnessstringYes—
$.selection[].sourcesarray<object>Yes—
$.selection[].sources[]objectYes—
$.recommendedarray<object; {"additionalProperties":true}>; {"maxItems":4}Yes—
$.recommended[]object; {"additionalProperties":true}Yes—
$.recommended[].refstringYes—
$.recommended[].keystringYes—
$.recommended[].namestringNo—
$.recommended[].unitstringYes—
$.recommended[].valuenumber | string | nullYes—
$.recommended[].freshnessstringYes—
$.recommended[].sourcesarray<object>Yes—
$.recommended[].sources[]objectYes—
$.optionsarray<object; {"additionalProperties":true}>Yes—
$.options[]object; {"additionalProperties":true}Yes—
$.options[].refstringYes—
$.options[].keystringYes—
$.options[].namestringNo—
$.options[].unitstringYes—
$.options[].valuenumber | string | nullYes—
$.options[].freshnessstringYes—
$.options[].sourcesarray<object>Yes—
$.options[].sources[]objectYes—
$.next_cursorstringYes—
Stable error codes
unauthorized

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
$.limitinteger | stringNoResource protection returns HTTP 429 with Retry-After, a limit identifier and scope. Retry only after the waiting time; telemetry retries must preserve IDs and payloads. Rejected telemetry batches are atomic.
$.scopestring; {"enum":["owner","actor","free_pool","platform","capacity","network"]}No—
$.field_errorsarray<object>; {"maxItems":64}No—
$.field_errors[]objectYes—
$.field_errors[].pathstring; {"maxLength":256}Yes—
$.field_errors[].message_keystringYes—
$.field_errors[].message_paramsobject; {"additionalProperties":true}No—
Stable error codes
browser_session_required
forbidden
csrf
invalid_origin
workspace_scope

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
$.limitinteger | stringNoResource protection returns HTTP 429 with Retry-After, a limit identifier and scope. Retry only after the waiting time; telemetry retries must preserve IDs and payloads. Rejected telemetry batches are atomic.
$.scopestring; {"enum":["owner","actor","free_pool","platform","capacity","network"]}No—
$.field_errorsarray<object>; {"maxItems":64}No—
$.field_errors[]objectYes—
$.field_errors[].pathstring; {"maxLength":256}Yes—
$.field_errors[].message_keystringYes—
$.field_errors[].message_paramsobject; {"additionalProperties":true}No—
Stable error codes
not_found

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
$.limitinteger | stringNoResource protection returns HTTP 429 with Retry-After, a limit identifier and scope. Retry only after the waiting time; telemetry retries must preserve IDs and payloads. Rejected telemetry batches are atomic.
$.scopestring; {"enum":["owner","actor","free_pool","platform","capacity","network"]}No—
$.field_errorsarray<object>; {"maxItems":64}No—
$.field_errors[]objectYes—
$.field_errors[].pathstring; {"maxLength":256}Yes—
$.field_errors[].message_keystringYes—
$.field_errors[].message_paramsobject; {"additionalProperties":true}No—
Stable error codes
revision_conflict
idempotency_conflict

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
$.limitinteger | stringNoResource protection returns HTTP 429 with Retry-After, a limit identifier and scope. Retry only after the waiting time; telemetry retries must preserve IDs and payloads. Rejected telemetry batches are atomic.
$.scopestring; {"enum":["owner","actor","free_pool","platform","capacity","network"]}No—
$.field_errorsarray<object>; {"maxItems":64}No—
$.field_errors[]objectYes—
$.field_errors[].pathstring; {"maxLength":256}Yes—
$.field_errors[].message_keystringYes—
$.field_errors[].message_paramsobject; {"additionalProperties":true}No—
Stable error codes
invalid_input
invalid_device
invalid_reference
invalid_idempotency_key

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
$.limitinteger | stringNoResource protection returns HTTP 429 with Retry-After, a limit identifier and scope. Retry only after the waiting time; telemetry retries must preserve IDs and payloads. Rejected telemetry batches are atomic.
$.scopestring; {"enum":["owner","actor","free_pool","platform","capacity","network"]}No—
$.field_errorsarray<object>; {"maxItems":64}No—
$.field_errors[]objectYes—
$.field_errors[].pathstring; {"maxLength":256}Yes—
$.field_errors[].message_keystringYes—
$.field_errors[].message_paramsobject; {"additionalProperties":true}No—
Stable error codes
unavailable

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
$.limitinteger | stringNoResource protection returns HTTP 429 with Retry-After, a limit identifier and scope. Retry only after the waiting time; telemetry retries must preserve IDs and payloads. Rejected telemetry batches are atomic.
$.scopestring; {"enum":["owner","actor","free_pool","platform","capacity","network"]}No—
$.field_errorsarray<object>; {"maxItems":64}No—
$.field_errors[]objectYes—
$.field_errors[].pathstring; {"maxLength":256}Yes—
$.field_errors[].message_keystringYes—
$.field_errors[].message_paramsobject; {"additionalProperties":true}No—

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.

shell
curl --request GET --header "Cookie: $MB_COOKIE" --header "X-CSRF-Token: $MB_CSRF" "https://metribeacon.com/api/v1/devices/00000000-0000-4000-8000-000000000001/summary-metrics"
python
import json, os, urllib.request
headers = {"Cookie": os.environ["MB_COOKIE"], "X-CSRF-Token": os.environ["MB_CSRF"], "Content-Type": "application/json"}
request = urllib.request.Request("https://metribeacon.com/api/v1/devices/00000000-0000-4000-8000-000000000001/summary-metrics", method="GET", headers=headers, data=None)
with urllib.request.urlopen(request, timeout=30) as response:
    print(json.load(response))
javascript
const response = await fetch("https://metribeacon.com/api/v1/devices/00000000-0000-4000-8000-000000000001/summary-metrics", {method: "GET", credentials: "same-origin", headers: {"Content-Type":"application/json", "X-CSRF-Token":csrfToken}});
console.log(response.status, await response.json());
go
package main
import ("fmt"; "net/http"; "os"; "strings"; "time")
func main() {
 client := &http.Client{Timeout:30*time.Second}
 request, err := http.NewRequest("GET","https://metribeacon.com/api/v1/devices/00000000-0000-4000-8000-000000000001/summary-metrics",strings.NewReader(""))
 if err != nil { panic(err) }
 request.Header.Set("Cookie",os.Getenv("MB_COOKIE"))
 request.Header.Set("X-CSRF-Token",os.Getenv("MB_CSRF"))
 request.Header.Set("Content-Type","application/json")
 response,err := client.Do(request)
 if err != nil {panic(err)}
 defer response.Body.Close()
 fmt.Println(response.StatusCode)
}