hosting
POST /v1/sites/{siteId}/seo-metrics/check
Run an on-demand authority check for a hosted site.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/seo-metrics/check \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Fetch this site's authority metrics now, against the customer's own metered daily allowance, and store the reading so it joins the site's history. ⭐ **A fresh stored reading is returned WITHOUT spending anything.** If the site was measured within the caching window the response comes back with `spent_lookup: false` and neither the daily allowance nor the provider is touched — which is what lets the Domains screen and the site panel share one purchase rather than buying the answer twice. ⛔ There is no `force`. The fleet sweep owns a hosted site's cadence; a flag that spent a unit however recently we measured would be a button whose whole purpose is to overpay. A customer who genuinely wants to re-ask uses `POST /v1/domains/check`. Requires the `majestic_metrics` entitlement, on the site's own plan or the org's. An account that is suspended or has no active subscription is refused before anything is spent (`403`), and its existing readings stay on screen.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
fqdn | string | Yes | — |
state | string<measured, not_in_index, never_fetched> | Yes | `measured` — the provider returned figures (which may be zero, a real measurement). `not_in_index` — the provider answered and has never crawled this domain. `never_fetched` — n… |
measured_at | string | No | When the stored reading was taken. Null when never fetched. |
is_stale | boolean | Yes | True when the reading is older than the 24h refresh window, or absent entirely. A hint that a refresh is worth its allowance — not an indication the figures are wrong. |
metrics | SeoAuthorityMetrics | No | — |
spent_lookup | boolean | Yes | False when the answer came from a recent stored reading and cost nothing. |
quota | SeoLookupQuota | Yes | The research allowance meter, and what more costs. |
Errors this endpoint can return
401 · 403 · 404 · 429 · 503