MetriBeacon
Menu

GET Read account-wide usage and limits

/api/v1/usage

With table=1, returns the complete authorized monitor contributor collection as filtered cursor pages. Sort also accepts items, bytes and planned for descending numeric contributions. The unpaged response remains the account usage summary.

On this page

Access and permissions

With table=1, returns the complete authorized monitor contributor collection as filtered cursor pages. Sort also accepts items, bytes and planned for descending numeric contributions. The unpaged response remains the account usage summary.

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
workspace_idURL querystring; {"format":"uuid"}NoSelect an accessible workspace and its owner account budget. Members see only this workspace’s monitor details.
device_idURL querystring; {"format":"uuid"}NoKeep this accessible monitor in the bounded breakdown, for editing previews. Foreign or inaccessible monitors return 404.
forecast_sortURL querystring; {"enum":["items","events","bytes","event_bytes","planned","planned_items","planned_events","planned_bytes","planned_event_bytes"],"default":"items"}NoSelect the top 100 monitors by booked objects, booked bytes or planned daily objects before limiting the result. The requested device stays included.
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.
limitURL queryinteger; {"default":50,"maximum":100,"minimum":1}NoPage size, 1–100; default 50. A following page exists only when another matching row is available.
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":["items","bytes","planned","newest","oldest","name_asc","name_desc","events","event_bytes","planned_items","planned_events","planned_bytes","planned_event_bytes","projected_items","projected_events","projected_bytes","projected_event_bytes"]}NoStable order with the record ID as a tie breaker: newest, oldest, name_asc or name_desc.
typeURL querystringNoExact field filter; omit the parameter to include all values.
statusURL querystringNoExact field filter; omit the parameter to include all values.
copy_sourceURL querystring; {"enum":["device","workspace"]}NoOptional metadata-only copy estimate for the selected monitor or workspace. No capacity is reserved.
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":["type","status"]}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).active_archive_queries_limitinteger; {"minimum":1}NoMaximum number of concurrent archive queries, including exports.
$ (anyOf 1).active_exports_limitinteger; {"minimum":1}NoMaximum number of concurrent exports.
$ (anyOf 1).alarms_limitintegerNo—
$ (anyOf 1).batch_bytes_limitintegerNo—
$ (anyOf 1).batch_items_limitintegerNo—
$ (anyOf 1).bytes_per_minute_limitintegerNo—
$ (anyOf 1).day_bytesintegerNo—
$ (anyOf 1).day_bytes_limitintegerNo—
$ (anyOf 1).day_event_bytesintegerNo—
$ (anyOf 1).day_event_bytes_limitintegerNo—
$ (anyOf 1).day_eventsintegerNo—
$ (anyOf 1).day_events_limitintegerNo—
$ (anyOf 1).day_itemsintegerNo—
$ (anyOf 1).day_items_limitintegerNo—
$ (anyOf 1).day_notificationsintegerNo—
$ (anyOf 1).day_pointsintegerNo—
$ (anyOf 1).day_points_limitintegerNo—
$ (anyOf 1).devicesintegerNo—
$ (anyOf 1).devices_limitintegerNo—
$ (anyOf 1).events_per_minute_limitintegerNo—
$ (anyOf 1).groupsinteger; {"minimum":0}NoActive groups across all workspaces owned by this account.
$ (anyOf 1).groups_limitinteger; {"minimum":1}NoEffective account limit for active groups.
$ (anyOf 1).items_per_minute_limitintegerNo—
$ (anyOf 1).keysintegerNo—
$ (anyOf 1).keys_limitintegerNo—
$ (anyOf 1).limitsobjectNoAccount limit field: limits.
$ (anyOf 1).limits.active_alarmsinteger; {"maximum":1099511627776,"minimum":1}NoActive alert rules.
$ (anyOf 1).limits.active_archive_queriesinteger; {"maximum":1099511627776,"minimum":1}NoQueued or running archive queries, including exports.
$ (anyOf 1).limits.active_devicesinteger; {"maximum":1099511627776,"minimum":1}NoActive monitors in the account.
$ (anyOf 1).limits.active_exportsinteger; {"maximum":1099511627776,"minimum":1}NoQueued or running exports. These also count toward archive query capacity.
$ (anyOf 1).limits.active_groupsinteger; {"maximum":1099511627776,"minimum":1}NoActive groups across the account’s workspaces.
$ (anyOf 1).limits.active_keysinteger; {"maximum":1099511627776,"minimum":1}NoActive API keys that have not been revoked.
$ (anyOf 1).limits.active_seriesinteger; {"maximum":1099511627776,"minimum":1}NoActive measurement series, including reserved series slots.
$ (anyOf 1).limits.active_workspacesinteger; {"maximum":1099511627776,"minimum":1}NoActive workspaces in the account.
$ (anyOf 1).limits.alarm_per_minuteinteger; {"maximum":1099511627776,"minimum":1}NoNew alert rules per minute.
$ (anyOf 1).limits.batch_bytesinteger; {"maximum":1099511627776,"minimum":1}NoBytes per data request. Size limits apply before and after decompression.
$ (anyOf 1).limits.batch_itemsinteger; {"maximum":1099511627776,"minimum":1}NoItems per data request.
$ (anyOf 1).limits.bytes_per_dayinteger; {"maximum":1099511627776,"minimum":1}NoTransferred bytes per UTC day, counted after decompression.
$ (anyOf 1).limits.bytes_per_minuteinteger; {"maximum":1099511627776,"minimum":1}NoTransferred bytes per minute, counted after decompression.
$ (anyOf 1).limits.device_per_dayinteger; {"maximum":1099511627776,"minimum":1}NoNew monitors per UTC day.
$ (anyOf 1).limits.device_per_minuteinteger; {"maximum":1099511627776,"minimum":1}NoNew monitors per minute.
$ (anyOf 1).limits.event_bytes_per_dayinteger; {"maximum":1099511627776,"minimum":1}NoEvent data in bytes per UTC day.
$ (anyOf 1).limits.event_per_dayinteger; {"maximum":1099511627776,"minimum":1}NoEvents per UTC day, in addition to the shared data limit.
$ (anyOf 1).limits.event_per_minuteinteger; {"maximum":1099511627776,"minimum":1}NoEvents per minute, in addition to the shared data limit.
$ (anyOf 1).limits.group_per_minuteinteger; {"maximum":1099511627776,"minimum":1}NoNew groups per minute.
$ (anyOf 1).limits.key_per_minuteinteger; {"maximum":1099511627776,"minimum":1}NoNew API keys per minute.
$ (anyOf 1).limits.live_series_per_connectioninteger; {"maximum":1099511627776,"minimum":1}NoMeasurement series per live connection.
$ (anyOf 1).limits.notifications_per_dayinteger; {"maximum":1099511627776,"minimum":1}NoNotifications across all channels per UTC day.
$ (anyOf 1).limits.notifications_per_hourinteger; {"maximum":1099511627776,"minimum":1}NoNotifications across all channels per hour.
$ (anyOf 1).limits.point_per_dayinteger; {"maximum":1099511627776,"minimum":1}NoNew readings and events together per UTC day.
$ (anyOf 1).limits.point_per_minuteinteger; {"maximum":1099511627776,"minimum":1}NoNew readings and events together per minute.
$ (anyOf 1).limits.request_per_minuteinteger; {"maximum":1099511627776,"minimum":1}NoData submission requests per minute.
$ (anyOf 1).limits.series_per_30_daysinteger; {"maximum":1099511627776,"minimum":1}NoNew measurement series over the last 30 days.
$ (anyOf 1).limits.series_per_minuteinteger; {"maximum":1099511627776,"minimum":1}NoNew measurement series per minute.
$ (anyOf 1).limits.workspace_per_minuteinteger; {"maximum":1099511627776,"minimum":1}NoNew workspaces per minute.
$ (anyOf 1).limits.active_browser_monitorsinteger; {"maximum":1000,"minimum":1}No—
$ (anyOf 1).limits.browser_seconds_per_dayinteger; {"maximum":86400,"minimum":1}No—
$ (anyOf 1).limits.check_artifact_bytesinteger; {"maximum":5368709120,"minimum":1}No—
$ (anyOf 1).limits.network_checks_per_minuteinteger; {"maximum":100000,"minimum":1}No—
$ (anyOf 1).limits.log_bytes_per_dayinteger; {"minimum":1,"maximum":1099511627776}NoThe normal log quota is 1 GiB of normalized, uncompressed accepted entries per UTC day, shared by all workspaces you own. Unverified machine accounts start with 100 MiB. Masking does not reduce billed bytes; filtering does. Logs have a separate budget from measurements and events. Individual increases appear in your account.
$ (anyOf 1).limits_versionstring; {"pattern":"^[0-9a-f]{64}$"}NoVersion of account type, defaults and individual values. Required when checking or saving changes.
$ (anyOf 1).live_series_per_connection_limitinteger; {"minimum":1}NoEffective limit for measurement series per live connection.
$ (anyOf 1).monitorsinteger; {"minimum":0} | array<object>No—
$ (anyOf 1).monitors (oneOf 1)integer; {"minimum":0}No—
$ (anyOf 1).monitors (oneOf 2)array<object>No—
$ (anyOf 1).monitors (oneOf 2)[]objectYes—
$ (anyOf 1).monitors_limitintegerNo—
$ (anyOf 1).new_devices_per_minute_limitintegerNo—
$ (anyOf 1).new_devices_todayintegerNo—
$ (anyOf 1).new_devices_today_limitintegerNo—
$ (anyOf 1).new_keys_per_minute_limitintegerNo—
$ (anyOf 1).new_series_30dintegerNo—
$ (anyOf 1).new_series_30d_limitintegerNo—
$ (anyOf 1).new_series_per_minute_limitintegerNo—
$ (anyOf 1).new_workspaces_per_minute_limitintegerNo—
$ (anyOf 1).notifications_per_day_limitintegerNo—
$ (anyOf 1).notifications_per_hour_limitintegerNo—
$ (anyOf 1).points_per_minute_limitintegerNo—
$ (anyOf 1).registration_originstringNoOriginal account registration path. Verification does not change this origin.
$ (anyOf 1).requests_per_minute_limitintegerNo—
$ (anyOf 1).seriesintegerNo—
$ (anyOf 1).series_limitintegerNo—
$ (anyOf 1).tierstringNo—
$ (anyOf 1).workspacesintegerNo—
$ (anyOf 1).workspaces_limitintegerNo—
$ (anyOf 1).forecastUsageForecastNoConsistent read-only snapshot of effective quotas, daily booked consumption and schedule estimates. Account totals include all owner workspaces; members receive monitor names only from their selected workspace. The requested monitor is retained within the maximum 100 entries. Projection to reset adds the remaining UTC-day fraction of the plan to booked usage. Bursts, events, replay and corrections are not predictable and capacity is not reserved.
$ (anyOf 1).forecast.monitorsarray<object>; {"maxItems":100}Yes—
$ (anyOf 1).forecast.monitors[]objectYesOne visible monitor. Scheduled rates exclude paused monitors, monitors pending deletion and disabled or archived series. HTTP uses its configured interval, derived series one result per minute, other series their expected interval. Byte estimates use the profile assumptions without heartbeat overhead.
$ (anyOf 1).forecast.monitors[].archivedbooleanYes—
$ (anyOf 1).forecast.monitors[].idstring; {"format":"uuid"}Yes—
$ (anyOf 1).forecast.monitors[].interval_secondsinteger; {"minimum":10} | nullYes—
$ (anyOf 1).forecast.monitors[].interval_seconds (anyOf 1)integer; {"minimum":10}No—
$ (anyOf 1).forecast.monitors[].interval_seconds (anyOf 2)nullNo—
$ (anyOf 1).forecast.monitors[].namestringYes—
$ (anyOf 1).forecast.monitors[].pausedbooleanYes—
$ (anyOf 1).forecast.monitors[].plannedQuotaDailyYesData objects include numeric points, states and text events. Events are the state/text subset. Bytes and event bytes are uncompressed charged payload sizes. Planned values are estimates per 24 hours; today values are booked counters.
$ (anyOf 1).forecast.monitors[].planned.bytesnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.monitors[].planned.event_bytesnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.monitors[].planned.eventsnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.monitors[].planned.itemsnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.monitors[].profile_plannedQuotaDailyNoData objects include numeric points, states and text events. Events are the state/text subset. Bytes and event bytes are uncompressed charged payload sizes. Planned values are estimates per 24 hours; today values are booked counters.
$ (anyOf 1).forecast.monitors[].profile_planned.bytesnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.monitors[].profile_planned.event_bytesnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.monitors[].profile_planned.eventsnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.monitors[].profile_planned.itemsnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.monitors[].recorded_fromstring; {"format":"date-time"} | nullYes—
$ (anyOf 1).forecast.monitors[].recorded_from (anyOf 1)string; {"format":"date-time"}No—
$ (anyOf 1).forecast.monitors[].recorded_from (anyOf 2)nullNo—
$ (anyOf 1).forecast.monitors[].todayQuotaDailyYesData objects include numeric points, states and text events. Events are the state/text subset. Bytes and event bytes are uncompressed charged payload sizes. Planned values are estimates per 24 hours; today values are booked counters.
$ (anyOf 1).forecast.monitors[].today.bytesnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.monitors[].today.event_bytesnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.monitors[].today.eventsnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.monitors[].today.itemsnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.monitors[].typestringYes—
$ (anyOf 1).forecast.monitors[].workspace_idstring; {"format":"uuid"}Yes—
$ (anyOf 1).forecast.other_todayQuotaDailyYesData objects include numeric points, states and text events. Events are the state/text subset. Bytes and event bytes are uncompressed charged payload sizes. Planned values are estimates per 24 hours; today values are booked counters.
$ (anyOf 1).forecast.other_today.bytesnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.other_today.event_bytesnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.other_today.eventsnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.other_today.itemsnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.plannedQuotaDailyYesData objects include numeric points, states and text events. Events are the state/text subset. Bytes and event bytes are uncompressed charged payload sizes. Planned values are estimates per 24 hours; today values are booked counters.
$ (anyOf 1).forecast.planned.bytesnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.planned.event_bytesnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.planned.eventsnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.planned.itemsnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.reset_atstring; {"format":"date-time"}Yes—
$ (anyOf 1).forecast.sampled_atstring; {"format":"date-time"}Yes—
$ (anyOf 1).forecast.truncatedbooleanYes—
$ (anyOf 1).forecast.workspace_plannedQuotaDailyYesData objects include numeric points, states and text events. Events are the state/text subset. Bytes and event bytes are uncompressed charged payload sizes. Planned values are estimates per 24 hours; today values are booked counters.
$ (anyOf 1).forecast.workspace_planned.bytesnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.workspace_planned.event_bytesnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.workspace_planned.eventsnumber; {"minimum":0}Yes—
$ (anyOf 1).forecast.workspace_planned.itemsnumber; {"minimum":0}Yes—
$ (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).limit_presentationarray<object>No—
$ (anyOf 1).limit_presentation[]objectYes—
$ (anyOf 1).limit_presentation[].keystringYes—
$ (anyOf 1).limit_presentation[].visibilitystring; {"enum":["core","contextual","protection"]}YesPresentation class: core allowances, contextual feature allowances, or background protection. Raw limits remain available and enforced.
$ (anyOf 1).limit_presentation[].contextstring; {"enum":["browser","logs"]}No—
$ (anyOf 1).series_slotsinteger; {"minimum":0}No—
$ (anyOf 1).copy_countsnull | objectNo—
$ (anyOf 1).copy_counts (anyOf 1)nullNo—
$ (anyOf 1).copy_counts (anyOf 2)objectNo—
$ (anyOf 1).copy_counts (anyOf 2).monitorsinteger; {"minimum":0}Yes—
$ (anyOf 1).copy_counts (anyOf 2).seriesinteger; {"minimum":0}Yes—
$ (anyOf 1) (anyOf 1)JSONNo—
$ (anyOf 1) (anyOf 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
{
  "active_archive_queries_limit": 2,
  "active_exports_limit": 1,
  "alarms_limit": 0,
  "batch_bytes_limit": 0,
  "batch_items_limit": 0,
  "bytes_per_minute_limit": 0,
  "day_bytes": 0,
  "day_bytes_limit": 0,
  "day_event_bytes": 0,
  "day_event_bytes_limit": 0,
  "day_events": 0,
  "day_events_limit": 0,
  "day_items": 0,
  "day_items_limit": 0,
  "day_notifications": 0,
  "day_points": 0,
  "day_points_limit": 0,
  "devices": 0,
  "devices_limit": 0,
  "events_per_minute_limit": 0,
  "groups": 2,
  "groups_limit": 100,
  "items_per_minute_limit": 0,
  "keys": 0,
  "keys_limit": 0,
  "limits": {
    "active_alarms": 200,
    "active_archive_queries": 2,
    "active_devices": 10,
    "active_exports": 1,
    "active_groups": 100,
    "active_keys": 20,
    "active_series": 200,
    "active_workspaces": 50,
    "alarm_per_minute": 10,
    "batch_bytes": 262144,
    "batch_items": 1000,
    "bytes_per_day": 1073741824,
    "bytes_per_minute": 2097152,
    "device_per_day": 20,
    "device_per_minute": 5,
    "event_bytes_per_day": 10485760,
    "event_per_day": 10000,
    "event_per_minute": 60,
    "group_per_minute": 10,
    "key_per_minute": 5,
    "live_series_per_connection": 32,
    "notifications_per_day": 500,
    "notifications_per_hour": 60,
    "point_per_day": 4000000,
    "point_per_minute": 3000,
    "request_per_minute": 180,
    "series_per_30_days": 500,
    "series_per_minute": 60,
    "workspace_per_minute": 10,
    "log_bytes_per_day": 1073741824
  },
  "limits_version": "0000000000000000000000000000000000000000000000000000000000000000",
  "live_series_per_connection_limit": 32,
  "monitors": 0,
  "monitors_limit": 0,
  "new_devices_per_minute_limit": 0,
  "new_devices_today": 0,
  "new_devices_today_limit": 0,
  "new_keys_per_minute_limit": 0,
  "new_series_30d": 0,
  "new_series_30d_limit": 0,
  "new_series_per_minute_limit": 0,
  "new_workspaces_per_minute_limit": 0,
  "notifications_per_day_limit": 0,
  "notifications_per_hour_limit": 0,
  "points_per_minute_limit": 0,
  "registration_origin": "demo",
  "requests_per_minute_limit": 0,
  "series": 0,
  "series_limit": 0,
  "tier": "demo",
  "workspaces": 0,
  "workspaces_limit": 0,
  "forecast": {
    "monitors": [],
    "other_today": {
      "bytes": 0,
      "event_bytes": 0,
      "events": 0,
      "items": 0
    },
    "planned": {
      "bytes": 0,
      "event_bytes": 0,
      "events": 0,
      "items": 0
    },
    "reset_at": "2026-10-03T00:00:00Z",
    "sampled_at": "2026-10-02T12:00:00Z",
    "truncated": false,
    "workspace_planned": {
      "bytes": 0,
      "event_bytes": 0,
      "events": 0,
      "items": 0
    }
  }
}
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
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"
}
Stable error codes
invalid_device
invalid_input
invalid_sort
invalid_workspace
invalid_copy_source
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
not_found

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/usage"
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/usage", 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/usage", {
  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/usage", 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)
}