domains
POST /v1/domains/{domainId}/seo-metrics/refresh
Fetch a fresh SEO authority reading for a domain.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/seo-metrics/refresh \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
domainId (path) | Uuid | Oui | The domain's id. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
fqdn | string | Oui | — |
state | string<measured, not_in_index, never_fetched> | Oui | `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 | Non | When the stored reading was taken. Null when never fetched. |
is_stale | boolean | Oui | 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 | Non | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429 · 503