Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.devhelm.io/llms.txt

Use this file to discover all available pages before exploring further.

Every monitor check produces a result record containing timing data, assertion outcomes, region information, and protocol-specific details.

Result fields

FieldTypeDescription
idUUIDUnique check result identifier
timestampdatetimeWhen the check ran
regionstringProbe region that executed the check
responseTimeMsintegerTotal response time in milliseconds
passedbooleanWhether all fail-severity assertions passed
failureReasonstringHuman-readable failure description (null if passed)
severityHintstringdown, degraded, or null

Assertion results

Each check evaluates all configured assertions. The result includes per-assertion outcomes:
FieldTypeDescription
typestringAssertion type (e.g., status_code, response_time)
passedbooleanWhether this assertion passed
severitystringfail or warn
expectedstringWhat was expected
actualstringWhat was observed
messagestringHuman-readable result description
A check is marked as failed if any assertion with fail severity fails. Assertions with warn severity don’t cause the check to fail but do record a degraded severity hint.

Protocol-specific details

Check results include protocol-specific data depending on the monitor type.

HTTP details

FieldDescription
statusCodeHTTP response status code
responseHeadersKey-value map of response headers
responseBodySnapshotTruncated response body
responseSizeBytesResponse body size in bytes
redirectCountNumber of redirects followed
redirectTargetFinal URL after redirects
tlsInfoTLS certificate and connection details

TLS information

When verifyTls is enabled, HTTP check results include:
FieldDescription
subjectCnCertificate common name
subjectSanSubject Alternative Names
issuerCnIssuer common name
issuerOrgIssuer organization
notBeforeCertificate validity start
notAfterCertificate expiry date
tlsVersionTLS protocol version (e.g., TLSv1.3)
cipherSuiteNegotiated cipher suite
chainValidWhether the certificate chain is valid

Viewing results

Dashboard

The monitor detail page shows check results in a timeline view with pass/fail status, response times, and assertion breakdowns.

CLI

devhelm monitors get <monitor-id>

API

curl https://api.devhelm.io/api/v1/monitors/<id>/check-results?limit=10 \
  -H "Authorization: Bearer $DEVHELM_API_TOKEN"

Retention

DevHelm retains raw check results based on your plan. Retention is queryable — your plan determines how far back you can read raw results via the API, dashboard, or SDKs. After your tier’s window expires, results are no longer returned by any read path; they are subsequently dropped from storage on the global retention cycle.
PlanQueryable raw retention
Free24 hours
Starter7 days
Pro30 days
Team90 days
Business / Enterprise180 days
Aggregated metrics (uptime percentage, average response time) shown in dashboard summaries are derived from the same window. Daily aggregates are kept longer than the raw window. If you need to permanently delete a monitor’s data on demand (e.g. for compliance), explicitly delete the monitor — that path purges associated data on request and is independent of plan retention.

Next steps

Monitoring overview

How monitors and check flow work.

Incident policies

How check results trigger incidents.