Skip to content

API reference/email

Read a domain monitor and its last results

GET/api/v1/email/domain-monitors/{monitorId}

authentication
Secret API key as a bearer token
billing
Free.

The monitor plus results: for every domain from the last run, its status (ok, flagged, dead or invalid), the flags that fired (parked, blocklisted, expiring, no_spf, no_dmarc, and the ones that compare with the previous run: provider_changed, spf_changed, dmarc_changed, dkim_lost, mta_sts_lost), whether it changed since the previous run, and the facts the next run compares against; keyed by the domain in punycode, or null until the first run has finished. A monitor that belongs to another account answers 404.

Parameters

name in type description
monitorIdrequiredpathintegerThe monitor's id from the list endpoint.

Example request

curl https://spaw.co/api/v1/email/domain-monitors/4 \
  -H "Authorization: Bearer sk_live_…"
const response = await fetch('https://spaw.co/api/v1/email/domain-monitors/4', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer sk_live_…',
  },
});
const result = await response.json();
import requests

response = requests.get(
    'https://spaw.co/api/v1/email/domain-monitors/4',
    headers={'Authorization': 'Bearer sk_live_…'},
)
result = response.json()
$ch = curl_init('https://spaw.co/api/v1/email/domain-monitors/4');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer sk_live_…'],
]);
$result = json_decode(curl_exec($ch), true);
from spaw import Client

client = Client('sk_live_…')
result = client.get_domain_monitor(4)
import Spaw from 'spaw';

const spaw = new Spaw({ apiKey: 'sk_live_…' });
const result = await spaw.getDomainMonitor(4);
use Spaw\Client;

$spaw = new Client('sk_live_…');
$result = $spaw->getDomainMonitor(4);

This endpoint has no console on its page. It answers with records from your own account, often by an id only you have, rather than about a value you can type here. The dashboard lists the same rows.

Responses

200The monitor.

{
    "success": true,
    "data": {
        "monitor": {
            "id": 4,
            "name": "Sending domains",
            "cadence": "daily",
            "domain_count": 2,
            "next_run_at": "2026-09-14T08:00:00+00:00",
            "last_run_at": "2026-09-13T08:00:03+00:00",
            "last_summary": {
                "total": 2,
                "ok": 1,
                "flagged": 1,
                "dead": 0,
                "invalid": 0,
                "changed": 1,
                "newly_flagged": 1,
                "credits_used": 0,
                "stopped_reason": null
            },
            "webhook_url": null,
            "webhook_events": "changes",
            "webhook_status": null,
            "webhook_detail": null,
            "prunes_after_days": 365,
            "created_at": "2026-09-01T08:00:00+00:00",
            "results": {
                "acme.com": {
                    "status": "flagged",
                    "flags": [
                        "no_dmarc",
                        "provider_changed",
                        "dmarc_changed"
                    ],
                    "changed": true,
                    "valid": true,
                    "mx_found": true,
                    "mx_provider": "other",
                    "mx_provider_type": "self_hosted",
                    "has_spf": true,
                    "spf_all": "-all",
                    "dmarc_policy": null,
                    "dkim_selectors": [],
                    "mta_sts": true,
                    "parked": false,
                    "mx_blocklisted": false,
                    "domain_expires_at": "2027-03-12"
                },
                "news.acme.com": {
                    "status": "ok",
                    "flags": [],
                    "changed": false,
                    "valid": true,
                    "mx_found": true,
                    "mx_provider": "google",
                    "mx_provider_type": "mailbox_provider",
                    "has_spf": true,
                    "spf_all": "-all",
                    "dmarc_policy": "reject",
                    "dkim_selectors": [
                        "google"
                    ],
                    "mta_sts": true,
                    "parked": false,
                    "mx_blocklisted": false,
                    "domain_expires_at": "2027-03-12"
                }
            }
        }
    }
}

401The key is missing, malformed, or revoked.

{
    "success": false,
    "error": {
        "code": "UNAUTHENTICATED",
        "message": "Provide a valid API key as a bearer token.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}

404No such record on this account.

{
    "success": false,
    "error": {
        "code": "NOT_FOUND",
        "message": "No record with that id on this account.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}

429Over 5 requests per second for the key. Retry after the limit resets.

{
    "success": false,
    "error": {
        "code": "RATE_LIMITED",
        "message": "Too many requests. Retry after the limit resets.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}

Error codes

Failures answer { success: false, error: { code, message, request_id } }. Each code has its own page.

markdown version·openapi.json