MetriBeacon
Menu

GET Read your device’s text events

/api/v1/devices/{id}/events

Read your device’s text events.

On this page

Access and permissions

Read your device’s text events.

Browser session: __Host-mb_session cookie.

Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.

Parameters and headers

FieldLocationType and limitsRequiredMeaning
idPathstring; {"format":"uuid"}YesResource UUID from the path. It must exist and be accessible to the acting identity.
fromURL querystring; {"format":"date-time"}NoInclusive lower UTC time boundary in RFC3339.
toURL querystring; {"format":"date-time"}NoExclusive upper UTC time boundary in RFC3339; must follow from.
limitURL queryinteger; {"maximum":100,"minimum":1,"default":50}NoPage size, 1–100; default 50. A following page exists only when another matching row is available.
tableURL querystring; {"enum":["1"]}NoSet to 1 for a filtered cursor page; omitting table parameters preserves the original response.
qURL querystring; {"maxLength":128}NoCase-insensitive literal search in the documented text fields, applied before the page limit.
cursorURL querystring; {"maxLength":4096}NoOpaque next_cursor from the preceding page. Keep resource, account, filters, sort and limit unchanged; collection cursors expire after 15 minutes.
sortURL querystring; {"enum":["newest","oldest","name_asc","name_desc"]}NoStable order with the record ID as a tie breaker: newest, oldest, name_asc or name_desc.
severityURL querystringNoExact field filter; omit the parameter to include all values.
event_typeURL querystringNoExact field filter; omit the parameter to include all values.
viewURL querystring; {"enum":["individual","grouped"],"default":"individual"}Noindividual (default) returns original events; grouped counts matching source, severity and state transitions across the complete filtered range before pagination. Original text is preserved for custom events. Available only for retained full messages.
series_idURL querystring; {"format":"uuid"}NoFilter by a series in this monitor. Unknown or ambiguous legacy sources have no series assignment.
group_tokenURL querystring; {"format":"uuid"}NoOpaque group token, valid for 15 minutes from the snapshot. Returns original group members using the saved range, filters and snapshot; cursor and limit page the members. Other filter parameters do not alter the group. Bound to the authenticated actor and monitor. Expired tokens return invalid_group_token.
counts_onlyURL querystring; {"enum":["1"]}NoReturn counts for the requested filter instead of table rows. Counts include search and other filters, excluding this filter selection, sorting and pagination.
count_filterURL querystring; {"enum":["severity","event_type","series_id"]}NoDeclared table filter to count. Requires counts_only=1.
snapshotURL querystring; {"format":"date-time"}NoOptional snapshot from the corresponding table page.

Request body

No request body.

Responses

HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/json

FieldType and limitsRequiredMeaning
$JSON | JSON | objectYes—
$ (anyOf 1)JSON | JSONNo—
$ (anyOf 1).eventsarray<ResolvedTextEvent>No—
$ (anyOf 1).events[]ResolvedTextEventYes—
$ (anyOf 1).events[].idstringYesUUID of this resource. Keep the returned identifier for subsequent operations.
$ (anyOf 1).events[].labelsobject | nullYesBounded string attributes. Series registration uses labels as part of the series identity.
$ (anyOf 1).events[].measured_atstring; {"format":"date-time"}YesObservation timestamp supplied by the device in UTC; follow the permitted past and future window.
$ (anyOf 1).events[].messagestringYes—
$ (anyOf 1).events[].received_atstring; {"format":"date-time"}YesTimestamp when the service accepted the observation or event.
$ (anyOf 1).events[].severitystringYesSeverity value from the listed vocabulary.
$ (anyOf 1).events[].contextEventContextNoResolved source information. A series link is supplied only for an unambiguous series in this monitor. Missing historical states are not inferred.
$ (anyOf 1).events[].context.series_idstring | nullNo—
$ (anyOf 1).events[].context.series_namestring | nullNo—
$ (anyOf 1).events[].context.series_kindstring | nullNo—
$ (anyOf 1).events[].context.component_namestring | nullNo—
$ (anyOf 1).events[].context.component_idstring | nullNo—
$ (anyOf 1).events[].context.parameter_keystring | nullNo—
$ (anyOf 1).events[].context.sourcestring | nullNo—
$ (anyOf 1).events[].context.title_keystring | nullNo—
$ (anyOf 1).truncatedbooleanYesTrue when the bounded response omits additional entries. Narrow the range or use the documented job or pagination flow.
$ (anyOf 1).limitinteger; {"maximum":100,"minimum":1}No—
$ (anyOf 1).next_cursorstringNoCursor for the next matching page; empty when no following page exists.
$ (anyOf 1).snapshotstring; {"format":"date-time"}NoUTC snapshot bound to the cursor; later-created rows do not enter that page sequence.
$ (anyOf 1).groupsarray<EventGroup>No—
$ (anyOf 1).groups[]EventGroupYes—
$ (anyOf 1).groups[].idstringYesUUID of this resource. Keep the returned identifier for subsequent operations.
$ (anyOf 1).groups[].severitystringYesSeverity value from the listed vocabulary.
$ (anyOf 1).groups[].messagestringYes—
$ (anyOf 1).groups[].labelsobjectYesBounded string attributes. Series registration uses labels as part of the series identity.
$ (anyOf 1).groups[].contextEventContextNoResolved source information. A series link is supplied only for an unambiguous series in this monitor. Missing historical states are not inferred.
$ (anyOf 1).groups[].context.series_idstring | nullNo—
$ (anyOf 1).groups[].context.series_namestring | nullNo—
$ (anyOf 1).groups[].context.series_kindstring | nullNo—
$ (anyOf 1).groups[].context.component_namestring | nullNo—
$ (anyOf 1).groups[].context.component_idstring | nullNo—
$ (anyOf 1).groups[].context.parameter_keystring | nullNo—
$ (anyOf 1).groups[].context.sourcestring | nullNo—
$ (anyOf 1).groups[].context.title_keystring | nullNo—
$ (anyOf 1).groups[].countinteger; {"minimum":1}Yes—
$ (anyOf 1).groups[].first_atstring; {"format":"date-time"}Yes—
$ (anyOf 1).groups[].last_atstring; {"format":"date-time"}Yes—
$ (anyOf 1).groups[].group_tokenstring; {"format":"uuid"}YesOpaque group token, valid for 15 minutes from the snapshot. Returns original group members using the saved range, filters and snapshot; cursor and limit page the members. Other filter parameters do not alter the group. Bound to the authenticated actor and monitor. Expired tokens return invalid_group_token.
$ (anyOf 1).sourcesarray<EventContext>No—
$ (anyOf 1).sources[]EventContextYesResolved source information. A series link is supplied only for an unambiguous series in this monitor. Missing historical states are not inferred.
$ (anyOf 1).sources[].series_idstring | nullNo—
$ (anyOf 1).sources[].series_namestring | nullNo—
$ (anyOf 1).sources[].series_kindstring | nullNo—
$ (anyOf 1).sources[].component_namestring | nullNo—
$ (anyOf 1).sources[].component_idstring | nullNo—
$ (anyOf 1).sources[].parameter_keystring | nullNo—
$ (anyOf 1).sources[].sourcestring | nullNo—
$ (anyOf 1).sources[].title_keystring | nullNo—
$ (anyOf 1) (oneOf 1)JSONNo—
$ (anyOf 1) (oneOf 2)JSONNo—
$ (anyOf 2)objectNo—
$ (anyOf 2).filter_countsTableFilterCountsYes—
$ (anyOf 2).filter_counts.fieldstringYes—
$ (anyOf 2).filter_counts.totalinteger; {"minimum":0}Yes—
$ (anyOf 2).filter_counts.valuesobjectYes—
$ (anyOf 2).filter_counts.completebooleanYes—
$ (anyOf 2).filter_counts.snapshotstring; {"format":"date-time"}Yes—
$ (anyOf 2).filter_counts.counted_atstring; {"format":"date-time"}Yes—
json
{
  "events": [],
  "truncated": false
}
Stable error codes
invalid_credential
unauthorized
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

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—
json
{
  "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"
}
Stable error codes
csrf
insufficient_scope
invalid_origin
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

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—
json
{
  "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"
}
Stable error codes
not_found
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

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—
json
{
  "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"
}
Stable error codes
invalid_device
invalid_limit
invalid_range
invalid_time
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

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—
json
{
  "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"
}
Stable error codes
unavailable
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
Retry-Afterstring; {"pattern":"^[0-9]+$"}Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

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—
json
{
  "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"
}

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 --silent --show-error --output /dev/null --write-out "%{http_code}\n" \
  --request GET \
  --header @"$HOME/.config/metribeacon/headers.txt" \
  "https://metribeacon.com/api/v1/devices/00000000-0000-4000-8000-000000000001/events"
python
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/devices/00000000-0000-4000-8000-000000000001/events", 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()
javascript
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/devices/00000000-0000-4000-8000-000000000001/events", {
  method: "GET", headers, redirect: "manual",
  signal: AbortSignal.timeout(10000),
});
console.log(response.status);
await response.body?.cancel();
go
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/devices/00000000-0000-4000-8000-000000000001/events", 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)
}