POST Query local and archived history
/api/v1/series/{id}/history/queries
With prefer_local=true, safely complete local raw charts return immediately without a job. Other queries use an asynchronous job combining local and archived history. Charts return at most 1,000 points and tables at most 2,000 rows per page. Auto selects an appropriate resolution. Results include actual resolution, source, completeness, snapshot and gaps; state results also include validity_seconds. A table cursor is an owned completed-job UUID preserving measurement-time/point-ID ordering; jobs and cursors expire after one day. At most two active jobs per account. Original-value charts accept at most 1,000 expected points. Denser requests return HTTP 422 with code invalid_resolution, message_key errors.api.historyChartTooDense, and message_params.limit and message_params.interval_seconds. Use resolution=auto for a chart or mode=table with resolution=raw to page original values within retention.
On this page
Access and permissions
With prefer_local=true, safely complete local raw charts return immediately without a job. Other queries use an asynchronous job combining local and archived history. Charts return at most 1,000 points and tables at most 2,000 rows per page. Auto selects an appropriate resolution. Results include actual resolution, source, completeness, snapshot and gaps; state results also include validity_seconds. A table cursor is an owned completed-job UUID preserving measurement-time/point-ID ordering; jobs and cursors expire after one day. At most two active jobs per account. Original-value charts accept at most 1,000 expected points. Denser requests return HTTP 422 with code invalid_resolution, message_key errors.api.historyChartTooDense, and message_params.limit and message_params.interval_seconds. Use resolution=auto for a chart or mode=table with resolution=raw to page original values within retention.
Browser session: __Host-mb_session cookie.
Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.
When using a browser session for a mutation, send the current CSRF token in X-CSRF-Token with the same-site cookie. OAuth consent uses its documented form field.
Parameters and headers
| Field | Location | Type and limits | Required | Meaning |
|---|---|---|---|---|
| id | Path | string; {"format":"uuid"} | Yes | Resource UUID from the path. It must exist and be accessible to the acting identity. |
| Origin | Header | string; {"format":"uri"} | No | If present, must match the canonical HTTPS origin. Sec-Fetch-Site cross-site is rejected. |
| X-CSRF-Token | Header | string | No | Browser CSRF cookie value. Not required when an allowed machine management credential is used. |
Request body
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object; {"additionalProperties":false} | Yes | — |
| $.cursor | string; {"format":"uuid"} | No | Use table for cursor pagination after filters and aggregation. Up to 50 rows are shown by the app; state categories count as individual rows. History job cursors expire after one day. |
| $.from | string; {"format":"date-time"} | No | Inclusive start of the requested UTC range in RFC 3339. |
| $.limit | integer; {"maximum":2000,"minimum":1} | No | At most 1000 chart points; at most 2000 table rows |
| $.mode | string; {"enum":["chart","table"]} | No | Use table for cursor pagination after filters and aggregation. Up to 50 rows are shown by the app; state categories count as individual rows. History job cursors expire after one day. |
| $.prefer_local | boolean; {"default":false} | No | Charts covering at most 24 hours may return numeric or state raw data directly when local completeness is proven, with at most 1,000 points. Evicted, denser or ineligible ranges remain asynchronous. |
| $.resolution | string; {"default":"auto","enum":["auto","raw","minute","quarter_hour","hour"]} | No | Requested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation. |
| $.to | string; {"format":"date-time"} | No | Exclusive end of the requested UTC range in RFC 3339. It must be later than from. |
| $.display_seconds | integer; {"minimum":0} | No | Requested table display bucket in seconds, a multiple of the native resolution. Use the chart result display_seconds to keep its aggregation unchanged by table page size. |
| $.filters | object; {"additionalProperties":false} | No | Table-only filters, applied after aggregation and across local and archived data. Numeric exact/minimum/maximum compare the original raw value or aggregate mean inclusively; q and state filter state text/categories. Event tables use q for event type, event_type and severity. Filtering never changes aggregation. |
| $.filters.event_type | string; {"maxLength":128} | No | — |
| $.filters.exact | number | No | — |
| $.filters.maximum | number | No | — |
| $.filters.minimum | number | No | — |
| $.filters.q | string; {"maxLength":128} | No | — |
| $.filters.severity | string; {"maxLength":128} | No | — |
| $.filters.state | string; {"maxLength":128} | No | — |
| $.order | string; {"enum":["oldest","newest"],"default":"oldest"} | No | Table order: newest or oldest (default). The cursor keeps the selected order and snapshot. Charts stay chronological. |
Responses
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object | Yes | — |
| $.resolution | string | Yes | Requested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation. |
| $.result | object | null | Yes | Completed operation result. Null or absent while a result is unavailable, according to this schema. |
| $.result (anyOf 1) | object | No | — |
| $.result (anyOf 1).completeness | string | Yes | — |
| $.result (anyOf 1).display_seconds | integer | Yes | — |
| $.result (anyOf 1).gaps | array<object> | Yes | — |
| $.result (anyOf 1).gaps[] | object | Yes | — |
| $.result (anyOf 1).gaps[].from | string; {"format":"date-time"} | Yes | Inclusive start of the requested UTC range in RFC 3339. |
| $.result (anyOf 1).gaps[].reason | string | Yes | Short explanation for the selected maintenance or attention condition. |
| $.result (anyOf 1).gaps[].to | string; {"format":"date-time"} | Yes | Exclusive end of the requested UTC range in RFC 3339. It must be later than from. |
| $.result (anyOf 1).kind | string | Yes | Resource kind or measurement type selected from the listed values. |
| $.result (anyOf 1).name | string | Yes | Human-readable resource name. Follow the listed length limit. |
| $.result (anyOf 1).next_cursor | string | No | Cursor for the next page; null or empty, as specified by the schema, means the current list has ended. |
| $.result (anyOf 1).points | array<object> | Yes | — |
| $.result (anyOf 1).points[] | object | Yes | — |
| $.result (anyOf 1).points[].count | integer | No | Number of observations or resources represented by this item. |
| $.result (anyOf 1).points[].counter_epoch | string | No | — |
| $.result (anyOf 1).points[].counter_increase | number | null | No | Counter increase accumulated across accepted adjacent readings; null where it does not apply. |
| $.result (anyOf 1).points[].counter_increase (anyOf 1) | number | No | — |
| $.result (anyOf 1).points[].counter_increase (anyOf 2) | null | No | — |
| $.result (anyOf 1).points[].counter_resets | integer | null | No | Number of detected counter resets in the aggregate; null where it does not apply. |
| $.result (anyOf 1).points[].counter_resets (anyOf 1) | integer | No | — |
| $.result (anyOf 1).points[].counter_resets (anyOf 2) | null | No | — |
| $.result (anyOf 1).points[].first_counter_epoch | string | No | — |
| $.result (anyOf 1).points[].last | number | Yes | Last accepted numeric value in the bucket. |
| $.result (anyOf 1).points[].last_at | string; {"format":"date-time"} | Yes | Timestamp of the last accepted observation in the bucket. |
| $.result (anyOf 1).points[].max | number | Yes | Maximum observed numeric value in the bucket. |
| $.result (anyOf 1).points[].mean | number | Yes | Arithmetic mean of accepted observations in the bucket; it is not a time-weighted interpolation. |
| $.result (anyOf 1).points[].min | number | Yes | Minimum observed numeric value in the bucket. |
| $.result (anyOf 1).points[].point_id | string | No | — |
| $.result (anyOf 1).points[].source_received_until | string; {"format":"date-time"} | Yes | Source-receipt watermark used for aggregate completeness. |
| $.result (anyOf 1).points[].state_value | string | null | No | — |
| $.result (anyOf 1).points[].state_value (anyOf 1) | string | No | — |
| $.result (anyOf 1).points[].state_value (anyOf 2) | null | No | — |
| $.result (anyOf 1).points[].states | object | No | — |
| $.result (anyOf 1).points[].sum | number | No | Sum of accepted numeric observations in the bucket. |
| $.result (anyOf 1).points[].time | string; {"format":"date-time"} | Yes | Observation timestamp or aggregate bucket start in UTC, according to the selected resolution. |
| $.result (anyOf 1).points[].value | number | null | No | — |
| $.result (anyOf 1).points[].value (anyOf 1) | number | No | — |
| $.result (anyOf 1).points[].value (anyOf 2) | null | No | — |
| $.result (anyOf 1).resolution | string | Yes | Requested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation. |
| $.result (anyOf 1).series_id | string | Yes | UUID of the measurement series belonging to the authorized device. |
| $.result (anyOf 1).snapshot | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 1).source | string | Yes | Source of the returned data or diagnostic record. |
| $.result (anyOf 1).truncated | boolean | Yes | True when the bounded response omits additional entries. Narrow the range or use the documented job or pagination flow. |
| $.result (anyOf 1).unit | string | Yes | Display unit for a numeric series; it does not automatically convert submitted values. |
| $.result (anyOf 1).validity_seconds | integer | No | — |
| $.result (anyOf 2) | null | No | — |
| $.snapshot | string; {"format":"date-time"} | Yes | — |
| $.status | string; {"const":"complete"} | Yes | — |
{
"resolution": "minute",
"result": {
"completeness": "complete",
"display_seconds": 60,
"gaps": [],
"kind": "gauge",
"name": "Synthetic CPU",
"points": [],
"resolution": "minute",
"series_id": "11111111-1111-4111-8111-111111111111",
"snapshot": "2026-09-30T12:00:00Z",
"source": "local",
"truncated": false,
"unit": "%"
},
"snapshot": "2026-09-30T12:00:00Z",
"status": "complete"
}| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object | Yes | — |
| $.display_seconds | integer | Yes | — |
| $.id | string | Yes | UUID of this resource. Keep the returned identifier for subsequent operations. |
| $.resolution | string | Yes | Requested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation. |
| $.snapshot | string; {"format":"date-time"} | Yes | — |
| $.status | string; {"const":"queued"} | Yes | — |
| $.status_url | string | Yes | — |
{
"display_seconds": 60,
"id": "22222222-2222-4222-8222-222222222222",
"resolution": "minute",
"snapshot": "2026-09-30T12:00:00Z",
"status": "queued",
"status_url": "/api/v1/archive/jobs/22222222-2222-4222-8222-222222222222"
}| Stable error codes |
|---|
| invalid_credential |
| unauthorized |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"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 |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"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 |
|---|
| invalid_cursor |
| not_found |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"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_cursor |
| invalid_kind |
| invalid_query |
| invalid_resolution |
| invalid_filters |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"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 |
|---|
| query_limit |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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-After | string; {"pattern":"^[0-9]+$"} | Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"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": 429,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| unavailable |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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-After | string; {"pattern":"^[0-9]+$"} | Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"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 change does not have a general retry guarantee. If the response is unclear, read the affected resource before trying again. Follow Retry-After waiting times and request new sign-in or action codes when they expire.
HTTP 202 means the background job was accepted. Use the returned job ID to check its status. Download results when the job is complete, or inspect its error or cancellation status.
Request examples
Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.
Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.
curl --silent --show-error --output /dev/null --write-out "%{http_code}\n" \
--request POST \
--header @"$HOME/.config/metribeacon/headers.txt" \
--header "Content-Type: application/json" \
--data-binary '{}' \
"https://metribeacon.com/api/v1/series/00000000-0000-4000-8000-000000000001/history/queries"
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())
headers["Content-Type"] = "application/json"
request = Request("https://metribeacon.com/api/v1/series/00000000-0000-4000-8000-000000000001/history/queries", data="{}".encode("utf-8"), headers=headers, method="POST")
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"));
headers["Content-Type"] = "application/json";
const response = await fetch("https://metribeacon.com/api/v1/series/00000000-0000-4000-8000-000000000001/history/queries", {
method: "POST", headers, redirect: "manual",
signal: AbortSignal.timeout(10000), body: "{}",
});
console.log(response.status);
await response.body?.cancel();
package main
import (
"fmt"
"net/http"
"time"
"encoding/json"
"os"
"path/filepath"
"strings"
)
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("POST", "https://metribeacon.com/api/v1/series/00000000-0000-4000-8000-000000000001/history/queries", strings.NewReader("{}"))
if err != nil { panic("request failed; credentials and response omitted") }
for name, value := range headers { request.Header.Set(name, value) }
request.Header.Set("Content-Type", "application/json")
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)
}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- GET Read incidents and maintenance in a series time range
Read incidents and maintenance in a series time range.
- DELETE Archive a series and close its alarm incidents
Archive a series and close its alarm incidents.
- PATCH Update a series name, description or expected interval
Type, unit and labels are immutable after creation. Only the documented mutable fields can be changed.