domains
POST /v1/domains/check
Authority metrics for any domain, owned or not.
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/check \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'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
Majestic Trust Flow, Citation Flow, referring domains and topical trust for a domain you are considering — it does not have to be one of yours. Gated on `sites.view` plus **two** entitlements, both asserted **before** the provider is called: every check spends a billed index-item unit against Zinn®'s shared subscription, so an organisation that cannot see the answer never costs one. ⛔ The two keys answer different questions and neither implies the other. `domain_checker` says the plan includes **this product** — a checker for a domain you do not own. `majestic_metrics` says the plan includes the **authority data**, and it also gates the SEO tab on domains you already own. A plan may sell figures on your own domains without selling a pre-purchase checker, so one key could not express both. ⭐ A cached reading inside its TTL is returned **without spending anything** — re-checking a domain from an hour ago is the commonest thing an operator does while comparing a shortlist. Pass `force` when you genuinely want a fresh number. ⛔ A malformed hostname is refused **locally**, with a 422. A pasted URL is normalised rather than rejected (that is what is actually in the clipboard), but an email address or a sentence never reaches the provider — every one that did would be a billed unit answering a question nobody asked. ⛔ `null` and `0` mean opposite things in the response: `null` is *the provider did not tell us*, `0` is *the provider said zero*. A brand-new domain genuinely has Trust Flow 0 and so does one nobody has ever crawled, and on a PBN that difference decides a purchase. **Metered per day.** Each check that reaches the provider spends one of the account's daily allowance, and the response carries the meter as it stands afterwards, plus `spent_lookup` saying whether this particular answer cost anything. A cached reading is free. Nothing is charged when the request fails — a provider outage, an unconfigured provider or a malformed domain all leave the allowance untouched. `429` means the daily allowance is used up: buy more with `POST /v1/seo/quota/top-up`, or wait for the reset at midnight UTC. That is distinct from `403`, which means this account may not use the checker at all — the plan does not include it, or the account is suspended or unpaid.
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
fqdn | string | Oui | The domain to check. A pasted URL is accepted and normalised down to the hostname; `www.` is stripped, because it and the apex are one domain to every metrics provider and showi… |
force | boolean | Non | Fetch even if a fresh cached reading exists. ⛔ Spends a billed unit — leave it false unless the customer explicitly asked for a new number. |
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 | — |
spent_lookup | boolean | Oui | False when the answer came from a recent stored reading and cost nothing. |
quota | SeoLookupQuota | Oui | The research allowance meter, and what more costs. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 422 · 429 · 503