domains
POST /v1/domains/{domainId}/seo-metrics/refresh
Fetch a fresh SEO authority reading for a domain.
Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/seo-metrics/refresh \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
domainId (path) | Uuid | Ja | The domain's id. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
fqdn | string | Ja | — |
state | string<measured, not_in_index, never_fetched> | Ja | `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 | Nee | When the stored reading was taken. Null when never fetched. |
is_stale | boolean | Ja | 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 | Nee | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 429 · 503