domains
POST /v1/domains/{domainId}/seo-metrics/refresh
Fetch a fresh SEO authority reading for a domain.
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/domains/{domainId}/seo-metrics/refresh \
-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
Calls the upstream provider and stores a new snapshot, then returns it in the same shape as the GET. **Consumes provider allowance on every call**, so it is driven by an explicit user action or a scheduled sweep — never by rendering a page. Returns 503 when the provider is unreachable, unconfigured, or the allowance is exhausted; in every one of those cases the previously stored reading is left untouched and still served by the GET.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
domainId (path) | Uuid | Yes | The domain's id. |
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 | — |
Errors this endpoint can return
401 · 403 · 404 · 429 · 503