MetriBeacon
Menu

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

FieldLocationType and limitsRequiredMeaning
idPathstring; {"format":"uuid"}YesResource UUID from the path. It must exist and be accessible to the acting identity.

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
$objectYes—
$.created_atstring; {"format":"date-time"}YesCreation timestamp in RFC 3339 UTC.
$.display_secondsintegerNo—
$.download_urlstringNo—
$.error_codestring | nullYes—
$.error_code (anyOf 1)stringNo—
$.error_code (anyOf 2)nullNo—
$.formatstringYes—
$.fromstring; {"format":"date-time"}YesInclusive start of the requested UTC range in RFC 3339.
$.idstringYesUUID of this resource. Keep the returned identifier for subsequent operations.
$.modestringNo—
$.progressnumber; {"minimum":0,"maximum":1}NoCompleted fraction between 0 and 1.
$.resolutionstringYesRequested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation.
$.resultHistoryResult | ArchiveNumericResult | ArchiveRollupResult | ArchiveStateResult | ArchiveStateRollupResult | ArchiveEventRollupResult | MonitorOverviewResult | null | HTTPResponseTimesYesCompleted operation result. Null or absent while a result is unavailable, according to this schema.
$.result (anyOf 1)HistoryResultNo—
$.result (anyOf 1).completenessstringYes—
$.result (anyOf 1).display_secondsintegerYes—
$.result (anyOf 1).gapsarray<object>Yes—
$.result (anyOf 1).gaps[]objectYes—
$.result (anyOf 1).gaps[].fromstring; {"format":"date-time"}YesInclusive start of the requested UTC range in RFC 3339.
$.result (anyOf 1).gaps[].reasonstringYesShort explanation for the selected maintenance or attention condition.
$.result (anyOf 1).gaps[].tostring; {"format":"date-time"}YesExclusive end of the requested UTC range in RFC 3339. It must be later than from.
$.result (anyOf 1).kindstringYesResource kind or measurement type selected from the listed values.
$.result (anyOf 1).namestringYesHuman-readable resource name. Follow the listed length limit.
$.result (anyOf 1).next_cursorstringNoCursor for the next page; null or empty, as specified by the schema, means the current list has ended.
$.result (anyOf 1).pointsarray<object>Yes—
$.result (anyOf 1).points[]objectYes—
$.result (anyOf 1).points[].countintegerNoNumber of observations or resources represented by this item.
$.result (anyOf 1).points[].counter_epochstringNo—
$.result (anyOf 1).points[].counter_increasenumber | nullNoCounter increase accumulated across accepted adjacent readings; null where it does not apply.
$.result (anyOf 1).points[].counter_increase (anyOf 1)numberNo—
$.result (anyOf 1).points[].counter_increase (anyOf 2)nullNo—
$.result (anyOf 1).points[].counter_resetsinteger | nullNoNumber of detected counter resets in the aggregate; null where it does not apply.
$.result (anyOf 1).points[].counter_resets (anyOf 1)integerNo—
$.result (anyOf 1).points[].counter_resets (anyOf 2)nullNo—
$.result (anyOf 1).points[].first_counter_epochstringNo—
$.result (anyOf 1).points[].lastnumberYesLast accepted numeric value in the bucket.
$.result (anyOf 1).points[].last_atstring; {"format":"date-time"}YesTimestamp of the last accepted observation in the bucket.
$.result (anyOf 1).points[].maxnumberYesMaximum observed numeric value in the bucket.
$.result (anyOf 1).points[].meannumberYesArithmetic mean of accepted observations in the bucket; it is not a time-weighted interpolation.
$.result (anyOf 1).points[].minnumberYesMinimum observed numeric value in the bucket.
$.result (anyOf 1).points[].point_idstringNo—
$.result (anyOf 1).points[].source_received_untilstring; {"format":"date-time"}YesSource-receipt watermark used for aggregate completeness.
$.result (anyOf 1).points[].state_valuestring | nullNo—
$.result (anyOf 1).points[].state_value (anyOf 1)stringNo—
$.result (anyOf 1).points[].state_value (anyOf 2)nullNo—
$.result (anyOf 1).points[].statesobjectNo—
$.result (anyOf 1).points[].sumnumberNoSum of accepted numeric observations in the bucket.
$.result (anyOf 1).points[].timestring; {"format":"date-time"}YesObservation timestamp or aggregate bucket start in UTC, according to the selected resolution.
$.result (anyOf 1).points[].valuenumber | nullNo—
$.result (anyOf 1).points[].value (anyOf 1)numberNo—
$.result (anyOf 1).points[].value (anyOf 2)nullNo—
$.result (anyOf 1).points[].row_keystringNoStable category key for a state aggregate table row; raw point_id remains the original point UUID.
$.result (anyOf 1).points[].valid_untilstring; {"format":"date-time"}No—
$.result (anyOf 1).resolutionstringYesRequested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation.
$.result (anyOf 1).series_idstringYesUUID of the measurement series belonging to the authorized device.
$.result (anyOf 1).snapshotstring; {"format":"date-time"}Yes—
$.result (anyOf 1).sourcestringYesSource of the returned data or diagnostic record.
$.result (anyOf 1).truncatedbooleanYesTrue when the bounded response omits additional entries. Narrow the range or use the documented job or pagination flow.
$.result (anyOf 1).unitstringYesDisplay unit for a numeric series; it does not automatically convert submitted values.
$.result (anyOf 1).validity_secondsintegerNo—
$.result (anyOf 1).state_beforeobjectNoFor 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.timestring; {"format":"date-time"}Yes—
$.result (anyOf 1).state_before.point_idstringNo—
$.result (anyOf 1).state_before.state_valuestringYes—
$.result (anyOf 1).state_before.valid_untilstring; {"format":"date-time"}No—
$.result (anyOf 2)ArchiveNumericResultNo—
$.result (anyOf 2).pointsarray<object>Yes—
$.result (anyOf 2).points[]objectYes—
$.result (anyOf 2).points[].counter_epochstringYes—
$.result (anyOf 2).points[].point_idstringYes—
$.result (anyOf 2).points[].timestring; {"format":"date-time"}YesObservation timestamp or aggregate bucket start in UTC, according to the selected resolution.
$.result (anyOf 2).points[].valuenumberYes—
$.result (anyOf 2).resolutionstringYesRequested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation.
$.result (anyOf 2).series_idstring; {"format":"uuid"}YesUUID of the measurement series belonging to the authorized device.
$.result (anyOf 2).sourcestringYesSource of the returned data or diagnostic record.
$.result (anyOf 2).truncatedbooleanYesTrue when the bounded response omits additional entries. Narrow the range or use the documented job or pagination flow.
$.result (anyOf 3)ArchiveRollupResultNo—
$.result (anyOf 3).pointsarray<object>Yes—
$.result (anyOf 3).points[]objectYes—
$.result (anyOf 3).points[].countintegerYesNumber of observations or resources represented by this item.
$.result (anyOf 3).points[].counter_epochstringYes—
$.result (anyOf 3).points[].counter_increasenumberYesCounter increase accumulated across accepted adjacent readings; null where it does not apply.
$.result (anyOf 3).points[].counter_resetsintegerYesNumber of detected counter resets in the aggregate; null where it does not apply.
$.result (anyOf 3).points[].first_counter_epochstringYes—
$.result (anyOf 3).points[].lastnumberYesLast accepted numeric value in the bucket.
$.result (anyOf 3).points[].last_atstring; {"format":"date-time"}YesTimestamp of the last accepted observation in the bucket.
$.result (anyOf 3).points[].maxnumberYesMaximum observed numeric value in the bucket.
$.result (anyOf 3).points[].meannumberYesArithmetic mean of accepted observations in the bucket; it is not a time-weighted interpolation.
$.result (anyOf 3).points[].minnumberYesMinimum observed numeric value in the bucket.
$.result (anyOf 3).points[].source_received_untilstring; {"format":"date-time"}YesSource-receipt watermark used for aggregate completeness.
$.result (anyOf 3).points[].sumnumberYesSum of accepted numeric observations in the bucket.
$.result (anyOf 3).points[].timestring; {"format":"date-time"}YesObservation timestamp or aggregate bucket start in UTC, according to the selected resolution.
$.result (anyOf 3).resolutionstringYesRequested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation.
$.result (anyOf 3).series_idstring; {"format":"uuid"}YesUUID of the measurement series belonging to the authorized device.
$.result (anyOf 3).sourcestringYesSource of the returned data or diagnostic record.
$.result (anyOf 3).truncatedbooleanYesTrue when the bounded response omits additional entries. Narrow the range or use the documented job or pagination flow.
$.result (anyOf 4)ArchiveStateResultNo—
$.result (anyOf 4).kindstringYesResource kind or measurement type selected from the listed values.
$.result (anyOf 4).pointsarray<object>Yes—
$.result (anyOf 4).points[]objectYes—
$.result (anyOf 4).points[].point_idstringYes—
$.result (anyOf 4).points[].timestring; {"format":"date-time"}YesObservation timestamp or aggregate bucket start in UTC, according to the selected resolution.
$.result (anyOf 4).points[].valueboolean | stringYes—
$.result (anyOf 4).resolutionstringYesRequested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation.
$.result (anyOf 4).series_idstring; {"format":"uuid"}YesUUID of the measurement series belonging to the authorized device.
$.result (anyOf 4).sourcestringYesSource of the returned data or diagnostic record.
$.result (anyOf 4).truncatedbooleanYesTrue when the bounded response omits additional entries. Narrow the range or use the documented job or pagination flow.
$.result (anyOf 5)ArchiveStateRollupResultNo—
$.result (anyOf 5).kindstringYesResource kind or measurement type selected from the listed values.
$.result (anyOf 5).pointsarray<object>Yes—
$.result (anyOf 5).points[]objectYes—
$.result (anyOf 5).points[].duration_secondsnumberYes—
$.result (anyOf 5).points[].source_received_untilstring; {"format":"date-time"}YesSource-receipt watermark used for aggregate completeness.
$.result (anyOf 5).points[].timestring; {"format":"date-time"}YesObservation timestamp or aggregate bucket start in UTC, according to the selected resolution.
$.result (anyOf 5).points[].transitionsintegerYes—
$.result (anyOf 5).points[].valuestringYes—
$.result (anyOf 5).resolutionstringYesRequested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation.
$.result (anyOf 5).series_idstring; {"format":"uuid"}YesUUID of the measurement series belonging to the authorized device.
$.result (anyOf 5).sourcestringYesSource of the returned data or diagnostic record.
$.result (anyOf 5).truncatedbooleanYesTrue when the bounded response omits additional entries. Narrow the range or use the documented job or pagination flow.
$.result (anyOf 6)ArchiveEventRollupResultNo—
$.result (anyOf 6).device_idstring; {"format":"uuid"}YesUUID of the target device or monitor. The ingestion key must allow this device.
$.result (anyOf 6).kindstringYesResource kind or measurement type selected from the listed values.
$.result (anyOf 6).pointsarray<object>Yes—
$.result (anyOf 6).points[]objectYes—
$.result (anyOf 6).points[].countintegerYesNumber of observations or resources represented by this item.
$.result (anyOf 6).points[].duration_countintegerYes—
$.result (anyOf 6).points[].duration_max_msinteger | nullYes—
$.result (anyOf 6).points[].duration_max_ms (anyOf 1)integerNo—
$.result (anyOf 6).points[].duration_max_ms (anyOf 2)nullNo—
$.result (anyOf 6).points[].duration_min_msinteger | nullYes—
$.result (anyOf 6).points[].duration_min_ms (anyOf 1)integerNo—
$.result (anyOf 6).points[].duration_min_ms (anyOf 2)nullNo—
$.result (anyOf 6).points[].duration_sum_msintegerYes—
$.result (anyOf 6).points[].event_typestringYes—
$.result (anyOf 6).points[].severitystringYesSeverity value from the listed vocabulary.
$.result (anyOf 6).points[].source_received_untilstring; {"format":"date-time"}YesSource-receipt watermark used for aggregate completeness.
$.result (anyOf 6).points[].timestring; {"format":"date-time"}YesObservation timestamp or aggregate bucket start in UTC, according to the selected resolution.
$.result (anyOf 6).resolutionstringYesRequested data resolution. Aggregates summarize a bucket and do not reconstruct every original observation.
$.result (anyOf 6).sourcestringYesSource of the returned data or diagnostic record.
$.result (anyOf 6).truncatedbooleanYesTrue when the bounded response omits additional entries. Narrow the range or use the documented job or pagination flow.
$.result (anyOf 6).next_cursorstringNoCursor for the next matching page; empty when no following page exists.
$.result (anyOf 6).snapshotstring; {"format":"date-time"}No—
$.result (anyOf 6).gapsarray<object>No—
$.result (anyOf 6).gaps[]objectYes—
$.result (anyOf 6).gaps[].fromstring; {"format":"date-time"}No—
$.result (anyOf 6).gaps[].tostring; {"format":"date-time"}No—
$.result (anyOf 6).gaps[].reasonstringNo—
$.result (anyOf 6).completenessstringNo—
$.result (anyOf 7)MonitorOverviewResultNo—
$.result (anyOf 7).daysarray<object>; {"maxItems":90,"minItems":90}Yes—
$.result (anyOf 7).days[]objectYes—
$.result (anyOf 7).days[].before_creationbooleanYes—
$.result (anyOf 7).days[].coverage_percentnumber; {"minimum":0}Yes—
$.result (anyOf 7).days[].daystring; {"format":"date"}Yes—
$.result (anyOf 7).days[].down_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 7).days[].fromstring; {"format":"date-time"}Yes—
$.result (anyOf 7).days[].tostring; {"format":"date-time"}Yes—
$.result (anyOf 7).days[].unknown_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 7).days[].unobserved_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 7).days[].up_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 7).days[].uptime_percentnumber | null; {"maximum":100,"minimum":0}Yes—
$.result (anyOf 7).days[].confirming_secondsnumberYes—
$.result (anyOf 7).evidence_fromstring; {"format":"date-time"}Yes—
$.result (anyOf 7).monitor_idstring; {"format":"uuid"}Yes—
$.result (anyOf 7).periodsarray<object>; {"maxItems":4,"minItems":4}Yes—
$.result (anyOf 7).periods[]objectYes—
$.result (anyOf 7).periods[].before_creationbooleanYes—
$.result (anyOf 7).periods[].coverage_percentnumber; {"minimum":0}Yes—
$.result (anyOf 7).periods[].down_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 7).periods[].fromstring; {"format":"date-time"}Yes—
$.result (anyOf 7).periods[].hoursinteger; {"enum":[24,168,720,2160]}Yes—
$.result (anyOf 7).periods[].tostring; {"format":"date-time"}Yes—
$.result (anyOf 7).periods[].unknown_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 7).periods[].unobserved_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 7).periods[].up_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 7).periods[].uptime_percentnumber | null; {"maximum":100,"minimum":0}Yes—
$.result (anyOf 7).periods[].confirming_secondsnumberYes—
$.result (anyOf 7).series_idstring; {"format":"uuid"}Yes—
$.result (anyOf 7).snapshotstring; {"format":"date-time"}Yes—
$.result (anyOf 7).sourcestring; {"enum":["local","mixed","archive"]}Yes—
$.result (anyOf 7).timezonestringYes—
$.result (anyOf 8)nullNo—
$.result (anyOf 9)HTTPResponseTimesNo—
$.result (anyOf 9).monitor_idstring; {"format":"uuid"}Yes—
$.result (anyOf 9).snapshotstring; {"format":"date-time"}Yes—
$.result (anyOf 9).fromstring; {"format":"date-time"}Yes—
$.result (anyOf 9).tostring; {"format":"date-time"}Yes—
$.result (anyOf 9).display_secondsintegerYes—
$.result (anyOf 9).resolutionstringYes—
$.result (anyOf 9).sourcestringYes—
$.result (anyOf 9).completenessstringYes—
$.result (anyOf 9).sourcesarray<HTTPResponseSource>Yes—
$.result (anyOf 9).sources[]HTTPResponseSourceYes—
$.result (anyOf 9).sources[].idstring; {"format":"uuid"}Yes—
$.result (anyOf 9).sources[].location_idstring; {"format":"uuid"}Yes—
$.result (anyOf 9).sources[].namestringYes—
$.result (anyOf 9).sources[].groupstring; {"enum":["Europe","NorthAmerica","SouthAmerica","MiddleEast","Asia","Africa","Oceania","Private","Unknown"]}Yes—
$.result (anyOf 9).sources[].interval_secondsintegerYes—
$.result (anyOf 9).sources[].country_codestringYes—
$.result (anyOf 9).sources[].activebooleanYes—
$.result (anyOf 9).regionsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 9).regions[]object; {"additionalProperties":false}Yes—
$.result (anyOf 9).regions[].groupstring; {"enum":["Europe","NorthAmerica","SouthAmerica","MiddleEast","Asia","Africa","Oceania","Private","Unknown"]}Yes—
$.result (anyOf 9).regions[].source_countintegerYes—
$.result (anyOf 9).regions[].sumnumberYes—
$.result (anyOf 9).regions[].countintegerYes—
$.result (anyOf 9).regions[].pointsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 9).regions[].points[]object; {"additionalProperties":false}Yes—
$.result (anyOf 9).regions[].points[].timestring; {"format":"date-time"}Yes—
$.result (anyOf 9).regions[].points[].sumnumberYes—
$.result (anyOf 9).regions[].points[].countintegerYes—
$.result (anyOf 9).regions[].gapsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 9).regions[].gaps[]object; {"additionalProperties":false}Yes—
$.result (anyOf 9).regions[].gaps[].fromstring; {"format":"date-time"}Yes—
$.result (anyOf 9).regions[].gaps[].tostring; {"format":"date-time"}Yes—
$.result (anyOf 9).regions[].gaps[].reasonstringYes—
$.result (anyOf 9).sumnumberYes—
$.result (anyOf 9).countintegerYes—
$.result (anyOf 9).versioninteger; {"const":2}Yes—
$.result (anyOf 9).locationsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 9).locations[]object; {"additionalProperties":false}Yes—
$.result (anyOf 9).locations[].sumnumberYes—
$.result (anyOf 9).locations[].countintegerYes—
$.result (anyOf 9).locations[].pointsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 9).locations[].points[]object; {"additionalProperties":false}Yes—
$.result (anyOf 9).locations[].points[].timestring; {"format":"date-time"}Yes—
$.result (anyOf 9).locations[].points[].sumnumberYes—
$.result (anyOf 9).locations[].points[].countintegerYes—
$.result (anyOf 9).locations[].gapsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 9).locations[].gaps[]object; {"additionalProperties":false}Yes—
$.result (anyOf 9).locations[].gaps[].fromstring; {"format":"date-time"}Yes—
$.result (anyOf 9).locations[].gaps[].tostring; {"format":"date-time"}Yes—
$.result (anyOf 9).locations[].gaps[].reasonstringYes—
$.result (anyOf 9).locations[].series_idstring; {"format":"uuid"}Yes—
$.result (anyOf 9).locations[].location_idstring; {"format":"uuid"}Yes—
$.snapshotstring; {"format":"date-time"}No—
$.statusstring; {"enum":["queued","running","complete","failed","cancelled"]}Yes—
$.tostring; {"format":"date-time"}YesExclusive end of the requested UTC range in RFC 3339. It must be later than from.
$.partsarray<object>; {"maxItems":64}No—
$.parts[]objectYes—
$.parts[].partintegerYes—
$.parts[].pointsintegerYes—
$.parts[].gapsintegerYes—
$.parts[].bytesintegerYes—
$.parts[].sha256string; {"pattern":"^[a-f0-9]{64}$"}Yes—
$.parts[].download_urlstringYes—
$.backgroundbooleanNoThe job remains available after leaving the page, within the existing retention.
$.completed_atstring; {"format":"date-time"} | nullNo—
$.completed_at (anyOf 1)string; {"format":"date-time"}No—
$.completed_at (anyOf 2)nullNo—
$.expires_atstring; {"format":"date-time"}No—
$.error_detailobject; {"additionalProperties":false}No—
$.error_detail.message_keystringYes—
$.error_detail.message_paramsobject; {"additionalProperties":true}Yes—
json
{
  "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
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 401,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
csrf
insufficient_scope
invalid_origin
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 403,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
not_found
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 404,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
invalid_job
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 422,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
unavailable
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
Retry-Afterstring; {"pattern":"^[0-9]+$"}Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 503,
  "title": "Demo error",
  "type": "about:blank"
}

Retries and asynchronous work

This operation reads or validates without applying a resource mutation. Respect rate limits and credential lifetime.

Request examples

Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.

Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.

shell
curl --silent --show-error --output /dev/null --write-out "%{http_code}\n" \
  --request GET \
  --header @"$HOME/.config/metribeacon/headers.txt" \
  "https://metribeacon.com/api/v1/archive/jobs/00000000-0000-4000-8000-000000000001"
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/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()
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/archive/jobs/00000000-0000-4000-8000-000000000001", {
  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/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)
}