MetriBeacon
Menu

GET Confirm that heartbeat and an enabled measurement were accepted

/api/v1/agent/connection

Confirm the selected agent profile through saved data: a heartbeat and a numeric or state value from an enabled profile series, received since the requested time. Installer and process status do not establish readiness.

On this page

Access and permissions

Confirm the selected agent profile through saved data: a heartbeat and a numeric or state value from an enabled profile series, received since the requested time. Installer and process status do not establish readiness.

API write key in Authorization: Bearer. It allows data submission for the selected devices or all devices in its workspace.

Parameters and headers

FieldLocationType and limitsRequiredMeaning
sinceURL querystring; {"format":"date-time"}YesGenerate secrets locally and submit only hashes. Repeating an identical request with the same client token returns the same challenge. No account is created.

Request body

No request body.

Responses

application/json

FieldType and limitsRequiredMeaning
$AgentConnectionYes—
$.device_idstring; {"format":"uuid"}Yes—
$.heartbeat_acceptedbooleanYes—
$.measurement_acceptedbooleanYes—
$.readybooleanYes—
Stable error codes
invalid_time
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.

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 --fail-with-body --request GET 'https://metribeacon.com/api/v1/agent/connection?since=2026-09-30T12:00:00Z' --header 'Accept: application/json' --header 'Authorization: Bearer YOUR_DEVICE_KEY'
python
import urllib.request
headers = {'Accept': 'application/json', 'Authorization': 'Bearer YOUR_DEVICE_KEY'}
request = urllib.request.Request('https://metribeacon.com/api/v1/agent/connection?since=2026-09-30T12:00:00Z', headers=headers, method='GET')
with urllib.request.urlopen(request) as response:
    print(response.read().decode())
javascript
const response = await fetch("https://metribeacon.com/api/v1/agent/connection?since=2026-09-30T12:00:00Z", {"method": "GET", "headers": {"Accept": "application/json", "Authorization": "Bearer YOUR_DEVICE_KEY"}});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());
go
package main
import ("fmt"; "io"; "net/http"; "strings")
func main() {
 req, err := http.NewRequest("GET", "https://metribeacon.com/api/v1/agent/connection?since=2026-09-30T12:00:00Z", strings.NewReader("")); if err != nil { panic(err) }
 req.Header.Set("Accept", "application/json")
 req.Header.Set("Authorization", "Bearer YOUR_DEVICE_KEY")
 response, err := http.DefaultClient.Do(req); if err != nil { panic(err) }; defer response.Body.Close(); data, err := io.ReadAll(response.Body); if err != nil { panic(err) }; fmt.Printf("HTTP %d\n%s\n", response.StatusCode, data)
}