GET Read an archive job and its bounded result
/api/v1/archive/jobs/{id}
Read status and progress of your authorized history job. Completed multipart CSV jobs include all part URLs, row counts, sizes, SHA-256 checksums and explicit coverage in the result. No part is available before the whole range succeeds.
On this page
Access and permissions
Read status and progress of your authorized history job. Completed multipart CSV jobs include all part URLs, row counts, sizes, SHA-256 checksums and explicit coverage in the result. No part is available before the whole range succeeds.
Browser session: __Host-mb_session cookie.
Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.
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. |
Request body
No request body.
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 | — |
| $.created_at | string; {"format":"date-time"} | Yes | Creation timestamp in RFC 3339 UTC. |
| $.display_seconds | integer | No | — |
| $.download_url | string | No | — |
| $.error_code | string | null | Yes | — |
| $.error_code (anyOf 1) | string | No | — |
| $.error_code (anyOf 2) | null | No | — |
| $.format | string | Yes | — |
| $.from | string; {"format":"date-time"} | Yes | Inclusive start of the requested UTC range in RFC 3339. |
| $.id | string | Yes | UUID of this resource. Keep the returned identifier for subsequent operations. |
| $.mode | string | No | — |
| $.progress | number; {"minimum":0,"maximum":1} | No | Completed fraction between 0 and 1. |
| $.resolution | string | Yes | Requested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation. |
| $.result | HistoryResult | ArchiveNumericResult | ArchiveRollupResult | ArchiveStateResult | ArchiveStateRollupResult | ArchiveEventRollupResult | MonitorOverviewResult | null | HTTPResponseTimes | Yes | Completed operation result. Null or absent while a result is unavailable, according to this schema. |
| $.result (anyOf 1) | HistoryResult | 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).points[].row_key | string | No | Stable category key for a state aggregate table row; raw point_id remains the original point UUID. |
| $.result (anyOf 1).points[].valid_until | string; {"format":"date-time"} | 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 1).state_before | object | No | For raw state charts, the last accepted state before the requested start, limited by retention and state validity. It is context only and is not included in the original rows or pagination. |
| $.result (anyOf 1).state_before.time | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 1).state_before.point_id | string | No | — |
| $.result (anyOf 1).state_before.state_value | string | Yes | — |
| $.result (anyOf 1).state_before.valid_until | string; {"format":"date-time"} | No | — |
| $.result (anyOf 2) | ArchiveNumericResult | No | — |
| $.result (anyOf 2).points | array<object> | Yes | — |
| $.result (anyOf 2).points[] | object | Yes | — |
| $.result (anyOf 2).points[].counter_epoch | string | Yes | — |
| $.result (anyOf 2).points[].point_id | string | Yes | — |
| $.result (anyOf 2).points[].time | string; {"format":"date-time"} | Yes | Observation timestamp or aggregate bucket start in UTC, according to the selected resolution. |
| $.result (anyOf 2).points[].value | number | Yes | — |
| $.result (anyOf 2).resolution | string | Yes | Requested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation. |
| $.result (anyOf 2).series_id | string; {"format":"uuid"} | Yes | UUID of the measurement series belonging to the authorized device. |
| $.result (anyOf 2).source | string | Yes | Source of the returned data or diagnostic record. |
| $.result (anyOf 2).truncated | boolean | Yes | True when the bounded response omits additional entries. Narrow the range or use the documented job or pagination flow. |
| $.result (anyOf 3) | ArchiveRollupResult | No | — |
| $.result (anyOf 3).points | array<object> | Yes | — |
| $.result (anyOf 3).points[] | object | Yes | — |
| $.result (anyOf 3).points[].count | integer | Yes | Number of observations or resources represented by this item. |
| $.result (anyOf 3).points[].counter_epoch | string | Yes | — |
| $.result (anyOf 3).points[].counter_increase | number | Yes | Counter increase accumulated across accepted adjacent readings; null where it does not apply. |
| $.result (anyOf 3).points[].counter_resets | integer | Yes | Number of detected counter resets in the aggregate; null where it does not apply. |
| $.result (anyOf 3).points[].first_counter_epoch | string | Yes | — |
| $.result (anyOf 3).points[].last | number | Yes | Last accepted numeric value in the bucket. |
| $.result (anyOf 3).points[].last_at | string; {"format":"date-time"} | Yes | Timestamp of the last accepted observation in the bucket. |
| $.result (anyOf 3).points[].max | number | Yes | Maximum observed numeric value in the bucket. |
| $.result (anyOf 3).points[].mean | number | Yes | Arithmetic mean of accepted observations in the bucket; it is not a time-weighted interpolation. |
| $.result (anyOf 3).points[].min | number | Yes | Minimum observed numeric value in the bucket. |
| $.result (anyOf 3).points[].source_received_until | string; {"format":"date-time"} | Yes | Source-receipt watermark used for aggregate completeness. |
| $.result (anyOf 3).points[].sum | number | Yes | Sum of accepted numeric observations in the bucket. |
| $.result (anyOf 3).points[].time | string; {"format":"date-time"} | Yes | Observation timestamp or aggregate bucket start in UTC, according to the selected resolution. |
| $.result (anyOf 3).resolution | string | Yes | Requested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation. |
| $.result (anyOf 3).series_id | string; {"format":"uuid"} | Yes | UUID of the measurement series belonging to the authorized device. |
| $.result (anyOf 3).source | string | Yes | Source of the returned data or diagnostic record. |
| $.result (anyOf 3).truncated | boolean | Yes | True when the bounded response omits additional entries. Narrow the range or use the documented job or pagination flow. |
| $.result (anyOf 4) | ArchiveStateResult | No | — |
| $.result (anyOf 4).kind | string | Yes | Resource kind or measurement type selected from the listed values. |
| $.result (anyOf 4).points | array<object> | Yes | — |
| $.result (anyOf 4).points[] | object | Yes | — |
| $.result (anyOf 4).points[].point_id | string | Yes | — |
| $.result (anyOf 4).points[].time | string; {"format":"date-time"} | Yes | Observation timestamp or aggregate bucket start in UTC, according to the selected resolution. |
| $.result (anyOf 4).points[].value | boolean | string | Yes | — |
| $.result (anyOf 4).resolution | string | Yes | Requested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation. |
| $.result (anyOf 4).series_id | string; {"format":"uuid"} | Yes | UUID of the measurement series belonging to the authorized device. |
| $.result (anyOf 4).source | string | Yes | Source of the returned data or diagnostic record. |
| $.result (anyOf 4).truncated | boolean | Yes | True when the bounded response omits additional entries. Narrow the range or use the documented job or pagination flow. |
| $.result (anyOf 5) | ArchiveStateRollupResult | No | — |
| $.result (anyOf 5).kind | string | Yes | Resource kind or measurement type selected from the listed values. |
| $.result (anyOf 5).points | array<object> | Yes | — |
| $.result (anyOf 5).points[] | object | Yes | — |
| $.result (anyOf 5).points[].duration_seconds | number | Yes | — |
| $.result (anyOf 5).points[].source_received_until | string; {"format":"date-time"} | Yes | Source-receipt watermark used for aggregate completeness. |
| $.result (anyOf 5).points[].time | string; {"format":"date-time"} | Yes | Observation timestamp or aggregate bucket start in UTC, according to the selected resolution. |
| $.result (anyOf 5).points[].transitions | integer | Yes | — |
| $.result (anyOf 5).points[].value | string | Yes | — |
| $.result (anyOf 5).resolution | string | Yes | Requested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation. |
| $.result (anyOf 5).series_id | string; {"format":"uuid"} | Yes | UUID of the measurement series belonging to the authorized device. |
| $.result (anyOf 5).source | string | Yes | Source of the returned data or diagnostic record. |
| $.result (anyOf 5).truncated | boolean | Yes | True when the bounded response omits additional entries. Narrow the range or use the documented job or pagination flow. |
| $.result (anyOf 6) | ArchiveEventRollupResult | No | — |
| $.result (anyOf 6).device_id | string; {"format":"uuid"} | Yes | UUID of the target device or monitor. The ingestion key must allow this device. |
| $.result (anyOf 6).kind | string | Yes | Resource kind or measurement type selected from the listed values. |
| $.result (anyOf 6).points | array<object> | Yes | — |
| $.result (anyOf 6).points[] | object | Yes | — |
| $.result (anyOf 6).points[].count | integer | Yes | Number of observations or resources represented by this item. |
| $.result (anyOf 6).points[].duration_count | integer | Yes | — |
| $.result (anyOf 6).points[].duration_max_ms | integer | null | Yes | — |
| $.result (anyOf 6).points[].duration_max_ms (anyOf 1) | integer | No | — |
| $.result (anyOf 6).points[].duration_max_ms (anyOf 2) | null | No | — |
| $.result (anyOf 6).points[].duration_min_ms | integer | null | Yes | — |
| $.result (anyOf 6).points[].duration_min_ms (anyOf 1) | integer | No | — |
| $.result (anyOf 6).points[].duration_min_ms (anyOf 2) | null | No | — |
| $.result (anyOf 6).points[].duration_sum_ms | integer | Yes | — |
| $.result (anyOf 6).points[].event_type | string | Yes | — |
| $.result (anyOf 6).points[].severity | string | Yes | Severity value from the listed vocabulary. |
| $.result (anyOf 6).points[].source_received_until | string; {"format":"date-time"} | Yes | Source-receipt watermark used for aggregate completeness. |
| $.result (anyOf 6).points[].time | string; {"format":"date-time"} | Yes | Observation timestamp or aggregate bucket start in UTC, according to the selected resolution. |
| $.result (anyOf 6).resolution | string | Yes | Requested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation. |
| $.result (anyOf 6).source | string | Yes | Source of the returned data or diagnostic record. |
| $.result (anyOf 6).truncated | boolean | Yes | True when the bounded response omits additional entries. Narrow the range or use the documented job or pagination flow. |
| $.result (anyOf 6).next_cursor | string | No | Cursor for the next matching page; empty when no following page exists. |
| $.result (anyOf 6).snapshot | string; {"format":"date-time"} | No | — |
| $.result (anyOf 6).gaps | array<object> | No | — |
| $.result (anyOf 6).gaps[] | object | Yes | — |
| $.result (anyOf 6).gaps[].from | string; {"format":"date-time"} | No | — |
| $.result (anyOf 6).gaps[].to | string; {"format":"date-time"} | No | — |
| $.result (anyOf 6).gaps[].reason | string | No | — |
| $.result (anyOf 6).completeness | string | No | — |
| $.result (anyOf 7) | MonitorOverviewResult | No | — |
| $.result (anyOf 7).days | array<object>; {"maxItems":90,"minItems":90} | Yes | — |
| $.result (anyOf 7).days[] | object | Yes | — |
| $.result (anyOf 7).days[].before_creation | boolean | Yes | — |
| $.result (anyOf 7).days[].coverage_percent | number; {"minimum":0} | Yes | — |
| $.result (anyOf 7).days[].day | string; {"format":"date"} | Yes | — |
| $.result (anyOf 7).days[].down_seconds | number; {"minimum":0} | Yes | — |
| $.result (anyOf 7).days[].from | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 7).days[].to | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 7).days[].unknown_seconds | number; {"minimum":0} | Yes | — |
| $.result (anyOf 7).days[].unobserved_seconds | number; {"minimum":0} | Yes | — |
| $.result (anyOf 7).days[].up_seconds | number; {"minimum":0} | Yes | — |
| $.result (anyOf 7).days[].uptime_percent | number | null; {"maximum":100,"minimum":0} | Yes | — |
| $.result (anyOf 7).days[].confirming_seconds | number | Yes | — |
| $.result (anyOf 7).evidence_from | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 7).monitor_id | string; {"format":"uuid"} | Yes | — |
| $.result (anyOf 7).periods | array<object>; {"maxItems":4,"minItems":4} | Yes | — |
| $.result (anyOf 7).periods[] | object | Yes | — |
| $.result (anyOf 7).periods[].before_creation | boolean | Yes | — |
| $.result (anyOf 7).periods[].coverage_percent | number; {"minimum":0} | Yes | — |
| $.result (anyOf 7).periods[].down_seconds | number; {"minimum":0} | Yes | — |
| $.result (anyOf 7).periods[].from | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 7).periods[].hours | integer; {"enum":[24,168,720,2160]} | Yes | — |
| $.result (anyOf 7).periods[].to | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 7).periods[].unknown_seconds | number; {"minimum":0} | Yes | — |
| $.result (anyOf 7).periods[].unobserved_seconds | number; {"minimum":0} | Yes | — |
| $.result (anyOf 7).periods[].up_seconds | number; {"minimum":0} | Yes | — |
| $.result (anyOf 7).periods[].uptime_percent | number | null; {"maximum":100,"minimum":0} | Yes | — |
| $.result (anyOf 7).periods[].confirming_seconds | number | Yes | — |
| $.result (anyOf 7).series_id | string; {"format":"uuid"} | Yes | — |
| $.result (anyOf 7).snapshot | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 7).source | string; {"enum":["local","mixed","archive"]} | Yes | — |
| $.result (anyOf 7).timezone | string | Yes | — |
| $.result (anyOf 8) | null | No | — |
| $.result (anyOf 9) | HTTPResponseTimes | No | — |
| $.result (anyOf 9).monitor_id | string; {"format":"uuid"} | Yes | — |
| $.result (anyOf 9).snapshot | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 9).from | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 9).to | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 9).display_seconds | integer | Yes | — |
| $.result (anyOf 9).resolution | string | Yes | — |
| $.result (anyOf 9).source | string | Yes | — |
| $.result (anyOf 9).completeness | string | Yes | — |
| $.result (anyOf 9).sources | array<HTTPResponseSource> | Yes | — |
| $.result (anyOf 9).sources[] | HTTPResponseSource | Yes | — |
| $.result (anyOf 9).sources[].id | string; {"format":"uuid"} | Yes | — |
| $.result (anyOf 9).sources[].location_id | string; {"format":"uuid"} | Yes | — |
| $.result (anyOf 9).sources[].name | string | Yes | — |
| $.result (anyOf 9).sources[].group | string; {"enum":["Europe","NorthAmerica","SouthAmerica","MiddleEast","Asia","Africa","Oceania","Private","Unknown"]} | Yes | — |
| $.result (anyOf 9).sources[].interval_seconds | integer | Yes | — |
| $.result (anyOf 9).sources[].country_code | string | Yes | — |
| $.result (anyOf 9).sources[].active | boolean | Yes | — |
| $.result (anyOf 9).regions | array<object; {"additionalProperties":false}> | Yes | — |
| $.result (anyOf 9).regions[] | object; {"additionalProperties":false} | Yes | — |
| $.result (anyOf 9).regions[].group | string; {"enum":["Europe","NorthAmerica","SouthAmerica","MiddleEast","Asia","Africa","Oceania","Private","Unknown"]} | Yes | — |
| $.result (anyOf 9).regions[].source_count | integer | Yes | — |
| $.result (anyOf 9).regions[].sum | number | Yes | — |
| $.result (anyOf 9).regions[].count | integer | Yes | — |
| $.result (anyOf 9).regions[].points | array<object; {"additionalProperties":false}> | Yes | — |
| $.result (anyOf 9).regions[].points[] | object; {"additionalProperties":false} | Yes | — |
| $.result (anyOf 9).regions[].points[].time | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 9).regions[].points[].sum | number | Yes | — |
| $.result (anyOf 9).regions[].points[].count | integer | Yes | — |
| $.result (anyOf 9).regions[].gaps | array<object; {"additionalProperties":false}> | Yes | — |
| $.result (anyOf 9).regions[].gaps[] | object; {"additionalProperties":false} | Yes | — |
| $.result (anyOf 9).regions[].gaps[].from | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 9).regions[].gaps[].to | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 9).regions[].gaps[].reason | string | Yes | — |
| $.result (anyOf 9).sum | number | Yes | — |
| $.result (anyOf 9).count | integer | Yes | — |
| $.result (anyOf 9).version | integer; {"const":2} | Yes | — |
| $.result (anyOf 9).locations | array<object; {"additionalProperties":false}> | Yes | — |
| $.result (anyOf 9).locations[] | object; {"additionalProperties":false} | Yes | — |
| $.result (anyOf 9).locations[].sum | number | Yes | — |
| $.result (anyOf 9).locations[].count | integer | Yes | — |
| $.result (anyOf 9).locations[].points | array<object; {"additionalProperties":false}> | Yes | — |
| $.result (anyOf 9).locations[].points[] | object; {"additionalProperties":false} | Yes | — |
| $.result (anyOf 9).locations[].points[].time | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 9).locations[].points[].sum | number | Yes | — |
| $.result (anyOf 9).locations[].points[].count | integer | Yes | — |
| $.result (anyOf 9).locations[].gaps | array<object; {"additionalProperties":false}> | Yes | — |
| $.result (anyOf 9).locations[].gaps[] | object; {"additionalProperties":false} | Yes | — |
| $.result (anyOf 9).locations[].gaps[].from | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 9).locations[].gaps[].to | string; {"format":"date-time"} | Yes | — |
| $.result (anyOf 9).locations[].gaps[].reason | string | Yes | — |
| $.result (anyOf 9).locations[].series_id | string; {"format":"uuid"} | Yes | — |
| $.result (anyOf 9).locations[].location_id | string; {"format":"uuid"} | Yes | — |
| $.snapshot | string; {"format":"date-time"} | No | — |
| $.status | string; {"enum":["queued","running","complete","failed","cancelled"]} | Yes | — |
| $.to | string; {"format":"date-time"} | Yes | Exclusive end of the requested UTC range in RFC 3339. It must be later than from. |
| $.parts | array<object>; {"maxItems":64} | No | — |
| $.parts[] | object | Yes | — |
| $.parts[].part | integer | Yes | — |
| $.parts[].points | integer | Yes | — |
| $.parts[].gaps | integer | Yes | — |
| $.parts[].bytes | integer | Yes | — |
| $.parts[].sha256 | string; {"pattern":"^[a-f0-9]{64}$"} | Yes | — |
| $.parts[].download_url | string | Yes | — |
| $.background | boolean | No | The job remains available after leaving the page, within the existing retention. |
| $.completed_at | string; {"format":"date-time"} | null | No | — |
| $.completed_at (anyOf 1) | string; {"format":"date-time"} | No | — |
| $.completed_at (anyOf 2) | null | No | — |
| $.expires_at | string; {"format":"date-time"} | No | — |
| $.error_detail | object; {"additionalProperties":false} | No | — |
| $.error_detail.message_key | string | Yes | — |
| $.error_detail.message_params | object; {"additionalProperties":true} | Yes | — |
{
"created_at": "2026-09-30T12:00:00Z",
"error_code": "demo",
"format": "demo",
"from": "2026-09-30T12:00:00Z",
"id": "demo",
"resolution": "demo",
"result": {
"completeness": "demo",
"display_seconds": 0,
"gaps": [],
"kind": "demo",
"name": "demo",
"points": [],
"resolution": "demo",
"series_id": "demo",
"snapshot": "2026-09-30T12:00:00Z",
"source": "demo",
"truncated": false,
"unit": "demo"
},
"status": "queued",
"to": "2026-09-30T12:00:00Z"
}| 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 |
|---|
| 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_job |
| 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 |
|---|
| 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 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.
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/archive/jobs/00000000-0000-4000-8000-000000000001"
import json
from pathlib import Path
from urllib.request import Request, HTTPRedirectHandler, build_opener
from urllib.error import HTTPError
headers = json.loads((Path.home() / ".config/metribeacon/headers.json").read_text())
request = Request("https://metribeacon.com/api/v1/archive/jobs/00000000-0000-4000-8000-000000000001", data=None, headers=headers, method="GET")
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, request, fp, code, message, headers, target):
return None
opener = build_opener(NoRedirect())
try:
with opener.open(request, timeout=10) as response:
print(response.status)
except HTTPError as error:
print(error.code)
error.close()
import { readFile } from "node:fs/promises";
import { homedir } from "node:os";
import { join } from "node:path";
const headers = JSON.parse(await readFile(join(homedir(), ".config/metribeacon/headers.json"), "utf8"));
const response = await fetch("https://metribeacon.com/api/v1/archive/jobs/00000000-0000-4000-8000-000000000001", {
method: "GET", headers, redirect: "manual",
signal: AbortSignal.timeout(10000),
});
console.log(response.status);
await response.body?.cancel();
package main
import (
"fmt"
"net/http"
"time"
"encoding/json"
"os"
"path/filepath"
)
func main() {
home, err := os.UserHomeDir(); if err != nil { panic("request failed; credentials and response omitted") }
raw, err := os.ReadFile(filepath.Join(home, ".config/metribeacon/headers.json")); if err != nil { panic("request failed; credentials and response omitted") }
var headers map[string]string
if json.Unmarshal(raw, &headers) != nil { panic("invalid local headers") }
request, err := http.NewRequest("GET", "https://metribeacon.com/api/v1/archive/jobs/00000000-0000-4000-8000-000000000001", nil)
if err != nil { panic("request failed; credentials and response omitted") }
for name, value := range headers { request.Header.Set(name, value) }
client := &http.Client{Timeout: 10*time.Second, CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse }}
response, err := client.Do(request)
if err != nil { panic("request failed; credentials and response omitted") }
defer response.Body.Close()
fmt.Println(response.StatusCode)
}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- DELETE Cancel your pending or running archive query
Cancel your pending or running archive query.
- PATCH API: Continue a history job
Confirm that your own queued, running or completed history or CSV job is retained when the page closes. The query snapshot and quotas are unchanged. Explicit cancellation remains available.
- GET Download a completed CSV export
Only a completed owned CSV job can be downloaded. Formula-leading text is escaped. Expired or unavailable results cannot be recovered by guessing a filename.