Data Types
This page lists all the shared data types, enums, and configuration values used across the Oh Dear API. Individual endpoint pages link here when they reference these values.
Check Types #
Each monitor can have multiple checks enabled. You'll find these values in the type field throughout the API. See the checks endpoint for enabling and disabling checks.
Available check types: uptime, performance, broken_links, mixed_content, lighthouse, cron, application_health, sitemap, dns, domain, certificate_health, ai, ports, dns_blocklist
Link Types #
These values are used when configuring the broken links check via broken_links_check_settings.types (for example through the monitors endpoint).
| Value | Description |
|---|---|
link |
An HTML anchor link |
image |
An image source |
script |
A JavaScript resource |
stylesheet |
A CSS stylesheet |
og:image |
An Open Graph image meta tag |
Check Results #
Every check run produces a result, available in the latest_run_result field on the checks endpoint.
| Value | Description |
|---|---|
pending |
Check hasn't completed its first run yet |
succeeded |
Check passed without issues |
warning |
Non-critical issue detected |
failed |
Problem detected that needs attention |
errored-or-timed-out |
Check couldn't complete due to an error or timeout |
null |
No run result is recorded yet |
Summarized Check Results #
A simplified version of check results used by the check summary endpoint for a quick overview across all monitors.
Possible values: pending, succeeded, warning, failed, null
Crawler/Sitemap Speed #
Controls how aggressively our crawler visits your site when checking for broken links, mixed content, and sitemap issues. If our crawler causes high server load, you can slow it down.
| Value | Concurrent requests | Delay between requests |
|---|---|---|
slowest |
1 | 1000ms |
slow |
1 | 500ms |
default |
2 | 250ms |
fast |
2 | 250ms |
fastest |
4 | 100ms |
Lighthouse Device Emulation #
Controls the device profile used for Lighthouse audits. This affects viewport size, user agent, and CPU/network throttling to simulate real-world conditions.
Possible values: desktop, mobile
Lighthouse Continent #
The region your Lighthouse audit runs from. Pick the continent closest to your target audience for the most relevant performance scores.
Available regions: europe, north-america, asia
Response Header Conditions #
When configuring expected response headers on uptime checks, you specify how the header value should be matched.
| Value | Description |
|---|---|
contains |
Header value contains the given string |
not contains |
Header value does not contain the given string |
equals |
Header value exactly matches the given string |
matches pattern |
Header value matches a regex pattern |
Uptime Check Locations #
You can run uptime checks from one or more of these server locations.
| Region | Locations |
|---|---|
| Africa | cape town |
| Asia | bangalore, seoul, singapore, tokyo |
| Australia | sydney |
| Canada | toronto |
| Europe | frankfurt, london, paris, stockholm |
| Middle East | bahrain |
| South America | sao paulo |
| US East | new york |
| US Mid | dallas |
| US West | los angeles, san francisco |
DNS Record Types #
The DNS check monitors these record types and notifies you when any of them change.
Monitored record types: A, AAAA, CAA, CNAME, MX, NS, SOA, SRV, TXT, PTR
Uptime Check HTTP Verb #
The HTTP method used for uptime checks. Defaults to get.
Supported methods: get, post, patch, put
Feel free to reach out via [email protected] or on X via @OhDearApp if you have any other questions. We'd love to help!
