身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/domains/check \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fqdn": <string> }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
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.
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
fqdn | string | 是 | 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 | 否 | Fetch even if a fresh cached reading exists. ⛔ Spends a billed unit — leave it false unless the customer explicitly asked for a new number. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
fqdn | string | 是 | — |
state | string<measured, not_in_index, never_fetched> | 是 | `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 | 否 | When the stored reading was taken. Null when never fetched. |
is_stale | boolean | 是 | 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 | 否 | — |
spent_lookup | boolean | 是 | False when the answer came from a recent stored reading and cost nothing. |
quota | SeoLookupQuota | 是 | The research allowance meter, and what more costs. |
此端点可能返回的错误
401 · 403 · 422 · 429 · 503