MetriBeacon
Menu

POST Evaluate monitor availability

/api/v1/monitors/{id}/overview/evaluate

Evaluates the last 90 days and periods of 24 hours, 7, 30 and 90 days using the monitor’s aggregate availability source. Calendar days use the requesting account’s time zone. Unknown, paused and missing time is not confirmed uptime. Existing history-query capacity and retention apply. Reuses equivalent running jobs or results up to five minutes old; poll the returned archive job for completion.

On this page

Access and permissions

Evaluates the last 90 days and periods of 24 hours, 7, 30 and 90 days using the monitor’s aggregate availability source. Calendar days use the requesting account’s time zone. Unknown, paused and missing time is not confirmed uptime. Existing history-query capacity and retention apply. Reuses equivalent running jobs or results up to five minutes old; poll the returned archive job for completion.

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

FieldLocationType and limitsRequiredMeaning
idPathstring; {"format":"uuid"}YesResource ID in this workspace

Request body

No request body.

Responses

application/json

FieldType and limitsRequiredMeaning
$objectYes—
$.idstring; {"format":"uuid"}Yes—
$.resultMonitorOverviewResult | null | HTTPResponseTimesYes—
$.result (anyOf 1)MonitorOverviewResultNo—
$.result (anyOf 1).daysarray<object>; {"maxItems":90,"minItems":90}Yes—
$.result (anyOf 1).days[]objectYes—
$.result (anyOf 1).days[].before_creationbooleanYes—
$.result (anyOf 1).days[].coverage_percentnumber; {"minimum":0}Yes—
$.result (anyOf 1).days[].daystring; {"format":"date"}Yes—
$.result (anyOf 1).days[].down_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).days[].fromstring; {"format":"date-time"}Yes—
$.result (anyOf 1).days[].tostring; {"format":"date-time"}Yes—
$.result (anyOf 1).days[].unknown_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).days[].unobserved_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).days[].up_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).days[].uptime_percentnumber | null; {"maximum":100,"minimum":0}Yes—
$.result (anyOf 1).days[].confirming_secondsnumberYes—
$.result (anyOf 1).evidence_fromstring; {"format":"date-time"}Yes—
$.result (anyOf 1).monitor_idstring; {"format":"uuid"}Yes—
$.result (anyOf 1).periodsarray<object>; {"maxItems":4,"minItems":4}Yes—
$.result (anyOf 1).periods[]objectYes—
$.result (anyOf 1).periods[].before_creationbooleanYes—
$.result (anyOf 1).periods[].coverage_percentnumber; {"minimum":0}Yes—
$.result (anyOf 1).periods[].down_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).periods[].fromstring; {"format":"date-time"}Yes—
$.result (anyOf 1).periods[].hoursinteger; {"enum":[24,168,720,2160]}Yes—
$.result (anyOf 1).periods[].tostring; {"format":"date-time"}Yes—
$.result (anyOf 1).periods[].unknown_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).periods[].unobserved_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).periods[].up_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).periods[].uptime_percentnumber | null; {"maximum":100,"minimum":0}Yes—
$.result (anyOf 1).periods[].confirming_secondsnumberYes—
$.result (anyOf 1).series_idstring; {"format":"uuid"}Yes—
$.result (anyOf 1).snapshotstring; {"format":"date-time"}Yes—
$.result (anyOf 1).sourcestring; {"enum":["local","mixed","archive"]}Yes—
$.result (anyOf 1).timezonestringYes—
$.result (anyOf 2)nullNo—
$.result (anyOf 3)HTTPResponseTimesNo—
$.result (anyOf 3).monitor_idstring; {"format":"uuid"}Yes—
$.result (anyOf 3).snapshotstring; {"format":"date-time"}Yes—
$.result (anyOf 3).fromstring; {"format":"date-time"}Yes—
$.result (anyOf 3).tostring; {"format":"date-time"}Yes—
$.result (anyOf 3).display_secondsintegerYes—
$.result (anyOf 3).resolutionstringYes—
$.result (anyOf 3).sourcestringYes—
$.result (anyOf 3).completenessstringYes—
$.result (anyOf 3).sourcesarray<HTTPResponseSource>Yes—
$.result (anyOf 3).sources[]HTTPResponseSourceYes—
$.result (anyOf 3).sources[].idstring; {"format":"uuid"}Yes—
$.result (anyOf 3).sources[].location_idstring; {"format":"uuid"}Yes—
$.result (anyOf 3).sources[].namestringYes—
$.result (anyOf 3).sources[].groupstring; {"enum":["Europe","NorthAmerica","SouthAmerica","MiddleEast","Asia","Africa","Oceania","Private","Unknown"]}Yes—
$.result (anyOf 3).sources[].interval_secondsintegerYes—
$.result (anyOf 3).sources[].country_codestringYes—
$.result (anyOf 3).sources[].activebooleanYes—
$.result (anyOf 3).regionsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 3).regions[]object; {"additionalProperties":false}Yes—
$.result (anyOf 3).regions[].groupstring; {"enum":["Europe","NorthAmerica","SouthAmerica","MiddleEast","Asia","Africa","Oceania","Private","Unknown"]}Yes—
$.result (anyOf 3).regions[].source_countintegerYes—
$.result (anyOf 3).regions[].sumnumberYes—
$.result (anyOf 3).regions[].countintegerYes—
$.result (anyOf 3).regions[].pointsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 3).regions[].points[]object; {"additionalProperties":false}Yes—
$.result (anyOf 3).regions[].points[].timestring; {"format":"date-time"}Yes—
$.result (anyOf 3).regions[].points[].sumnumberYes—
$.result (anyOf 3).regions[].points[].countintegerYes—
$.result (anyOf 3).regions[].gapsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 3).regions[].gaps[]object; {"additionalProperties":false}Yes—
$.result (anyOf 3).regions[].gaps[].fromstring; {"format":"date-time"}Yes—
$.result (anyOf 3).regions[].gaps[].tostring; {"format":"date-time"}Yes—
$.result (anyOf 3).regions[].gaps[].reasonstringYes—
$.result (anyOf 3).sumnumberYes—
$.result (anyOf 3).countintegerYes—
$.result (anyOf 3).versioninteger; {"const":2}Yes—
$.result (anyOf 3).locationsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 3).locations[]object; {"additionalProperties":false}Yes—
$.result (anyOf 3).locations[].sumnumberYes—
$.result (anyOf 3).locations[].countintegerYes—
$.result (anyOf 3).locations[].pointsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 3).locations[].points[]object; {"additionalProperties":false}Yes—
$.result (anyOf 3).locations[].points[].timestring; {"format":"date-time"}Yes—
$.result (anyOf 3).locations[].points[].sumnumberYes—
$.result (anyOf 3).locations[].points[].countintegerYes—
$.result (anyOf 3).locations[].gapsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 3).locations[].gaps[]object; {"additionalProperties":false}Yes—
$.result (anyOf 3).locations[].gaps[].fromstring; {"format":"date-time"}Yes—
$.result (anyOf 3).locations[].gaps[].tostring; {"format":"date-time"}Yes—
$.result (anyOf 3).locations[].gaps[].reasonstringYes—
$.result (anyOf 3).locations[].series_idstring; {"format":"uuid"}Yes—
$.result (anyOf 3).locations[].location_idstring; {"format":"uuid"}Yes—
$.statusstring; {"enum":["queued","running","complete"]}Yes—

application/json

FieldType and limitsRequiredMeaning
$objectYes—
$.idstring; {"format":"uuid"}Yes—
$.resultMonitorOverviewResult | null | HTTPResponseTimesYes—
$.result (anyOf 1)MonitorOverviewResultNo—
$.result (anyOf 1).daysarray<object>; {"maxItems":90,"minItems":90}Yes—
$.result (anyOf 1).days[]objectYes—
$.result (anyOf 1).days[].before_creationbooleanYes—
$.result (anyOf 1).days[].coverage_percentnumber; {"minimum":0}Yes—
$.result (anyOf 1).days[].daystring; {"format":"date"}Yes—
$.result (anyOf 1).days[].down_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).days[].fromstring; {"format":"date-time"}Yes—
$.result (anyOf 1).days[].tostring; {"format":"date-time"}Yes—
$.result (anyOf 1).days[].unknown_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).days[].unobserved_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).days[].up_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).days[].uptime_percentnumber | null; {"maximum":100,"minimum":0}Yes—
$.result (anyOf 1).days[].confirming_secondsnumberYes—
$.result (anyOf 1).evidence_fromstring; {"format":"date-time"}Yes—
$.result (anyOf 1).monitor_idstring; {"format":"uuid"}Yes—
$.result (anyOf 1).periodsarray<object>; {"maxItems":4,"minItems":4}Yes—
$.result (anyOf 1).periods[]objectYes—
$.result (anyOf 1).periods[].before_creationbooleanYes—
$.result (anyOf 1).periods[].coverage_percentnumber; {"minimum":0}Yes—
$.result (anyOf 1).periods[].down_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).periods[].fromstring; {"format":"date-time"}Yes—
$.result (anyOf 1).periods[].hoursinteger; {"enum":[24,168,720,2160]}Yes—
$.result (anyOf 1).periods[].tostring; {"format":"date-time"}Yes—
$.result (anyOf 1).periods[].unknown_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).periods[].unobserved_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).periods[].up_secondsnumber; {"minimum":0}Yes—
$.result (anyOf 1).periods[].uptime_percentnumber | null; {"maximum":100,"minimum":0}Yes—
$.result (anyOf 1).periods[].confirming_secondsnumberYes—
$.result (anyOf 1).series_idstring; {"format":"uuid"}Yes—
$.result (anyOf 1).snapshotstring; {"format":"date-time"}Yes—
$.result (anyOf 1).sourcestring; {"enum":["local","mixed","archive"]}Yes—
$.result (anyOf 1).timezonestringYes—
$.result (anyOf 2)nullNo—
$.result (anyOf 3)HTTPResponseTimesNo—
$.result (anyOf 3).monitor_idstring; {"format":"uuid"}Yes—
$.result (anyOf 3).snapshotstring; {"format":"date-time"}Yes—
$.result (anyOf 3).fromstring; {"format":"date-time"}Yes—
$.result (anyOf 3).tostring; {"format":"date-time"}Yes—
$.result (anyOf 3).display_secondsintegerYes—
$.result (anyOf 3).resolutionstringYes—
$.result (anyOf 3).sourcestringYes—
$.result (anyOf 3).completenessstringYes—
$.result (anyOf 3).sourcesarray<HTTPResponseSource>Yes—
$.result (anyOf 3).sources[]HTTPResponseSourceYes—
$.result (anyOf 3).sources[].idstring; {"format":"uuid"}Yes—
$.result (anyOf 3).sources[].location_idstring; {"format":"uuid"}Yes—
$.result (anyOf 3).sources[].namestringYes—
$.result (anyOf 3).sources[].groupstring; {"enum":["Europe","NorthAmerica","SouthAmerica","MiddleEast","Asia","Africa","Oceania","Private","Unknown"]}Yes—
$.result (anyOf 3).sources[].interval_secondsintegerYes—
$.result (anyOf 3).sources[].country_codestringYes—
$.result (anyOf 3).sources[].activebooleanYes—
$.result (anyOf 3).regionsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 3).regions[]object; {"additionalProperties":false}Yes—
$.result (anyOf 3).regions[].groupstring; {"enum":["Europe","NorthAmerica","SouthAmerica","MiddleEast","Asia","Africa","Oceania","Private","Unknown"]}Yes—
$.result (anyOf 3).regions[].source_countintegerYes—
$.result (anyOf 3).regions[].sumnumberYes—
$.result (anyOf 3).regions[].countintegerYes—
$.result (anyOf 3).regions[].pointsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 3).regions[].points[]object; {"additionalProperties":false}Yes—
$.result (anyOf 3).regions[].points[].timestring; {"format":"date-time"}Yes—
$.result (anyOf 3).regions[].points[].sumnumberYes—
$.result (anyOf 3).regions[].points[].countintegerYes—
$.result (anyOf 3).regions[].gapsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 3).regions[].gaps[]object; {"additionalProperties":false}Yes—
$.result (anyOf 3).regions[].gaps[].fromstring; {"format":"date-time"}Yes—
$.result (anyOf 3).regions[].gaps[].tostring; {"format":"date-time"}Yes—
$.result (anyOf 3).regions[].gaps[].reasonstringYes—
$.result (anyOf 3).sumnumberYes—
$.result (anyOf 3).countintegerYes—
$.result (anyOf 3).versioninteger; {"const":2}Yes—
$.result (anyOf 3).locationsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 3).locations[]object; {"additionalProperties":false}Yes—
$.result (anyOf 3).locations[].sumnumberYes—
$.result (anyOf 3).locations[].countintegerYes—
$.result (anyOf 3).locations[].pointsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 3).locations[].points[]object; {"additionalProperties":false}Yes—
$.result (anyOf 3).locations[].points[].timestring; {"format":"date-time"}Yes—
$.result (anyOf 3).locations[].points[].sumnumberYes—
$.result (anyOf 3).locations[].points[].countintegerYes—
$.result (anyOf 3).locations[].gapsarray<object; {"additionalProperties":false}>Yes—
$.result (anyOf 3).locations[].gaps[]object; {"additionalProperties":false}Yes—
$.result (anyOf 3).locations[].gaps[].fromstring; {"format":"date-time"}Yes—
$.result (anyOf 3).locations[].gaps[].tostring; {"format":"date-time"}Yes—
$.result (anyOf 3).locations[].gaps[].reasonstringYes—
$.result (anyOf 3).locations[].series_idstring; {"format":"uuid"}Yes—
$.result (anyOf 3).locations[].location_idstring; {"format":"uuid"}Yes—
$.statusstring; {"enum":["queued","running","complete"]}Yes—
Stable error codes
invalid_session

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—
Stable error codes
csrf
forbidden
insufficient_scope

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—
Stable error codes
not_found

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—
Stable error codes
invalid_monitor

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—
Stable error codes
query_limit

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—
Stable error codes
unavailable

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—

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.

shell
curl --silent --show-error --output /dev/null --write-out "%{http_code}\n" --request POST --header @"$HOME/.config/metribeacon/headers.txt" "https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001/overview/evaluate"
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())
class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, request, fp, code, message, headers, target): return None
request=Request('https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001/overview/evaluate',data=None,headers=headers,method='POST')
try:
    with build_opener(NoRedirect()).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/monitors/00000000-0000-4000-8000-000000000001/overview/evaluate",{method:"POST",headers,redirect:"manual",signal:AbortSignal.timeout(10000)});
console.log(response.status);await response.body?.cancel();
go
package main
import("encoding/json";"fmt";"net/http";"os";"path/filepath";"time")
func main(){home,e:=os.UserHomeDir();if e!=nil{return};raw,e:=os.ReadFile(filepath.Join(home,".config/metribeacon/headers.json"));if e!=nil{return};var headers map[string]string;if json.Unmarshal(raw,&headers)!=nil{return};req,e:=http.NewRequest("POST","https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001/overview/evaluate",nil);if e!=nil{return};for k,v:=range headers{req.Header.Set(k,v)};client:=&http.Client{Timeout:10*time.Second,CheckRedirect:func(*http.Request,[]*http.Request)error{return http.ErrUseLastResponse}};res,e:=client.Do(req);if e!=nil{return};defer res.Body.Close();fmt.Println(res.StatusCode)}
  • HTTP API, OAuth and MCP

    Find the user API endpoints, their permissions, fields, examples and response formats.

  • GET Read the monitor’s aggregate availability source

    HTTP and TCP, UDP, DNS, TLS, ping, service, domain and browser monitors use one aggregate availability series per monitor. For multiple checking locations, this series follows the monitor’s configured confirmation and any/all/quorum policy. Per-location and per-engine durations are never added together. The catalog includes active monitors with availability collection enabled; the individual source also exposes retained history when collection is disabled. Unknown, paused and unobserved time never count as confirmed availability. SLOs and reports use the same source and retain their separate maintenance calculations.

  • POST Evaluate HTTP response times by location and region

    Compare all retained regular HTTP check durations by location or world region in one snapshot. Means are weighted by sample count; the overall average includes hidden locations. Missing measurements remain gaps. Automatic display shares a 16,000-point and 4 MiB result budget across both representations. Original and live capacity limits are explicit; realtime alarm series are unchanged.

  • GET Read SSL certificate details

    Read bounded, location-bound certificate evidence. Automatic certificate diagnostics and remaining-day measurements run hourly; domain diagnostics run daily. Rechecks require edit rights, a saved target, the current configuration revision and an operation id. They use check quotas without changing regular HTTP measurements or alarm confirmations. Unknown or stale evidence does not confirm validity.