hosting
GET /v1/sites/{siteId}/seo-settings
How often this site's SEO metrics are checked, and what is shown.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/seo-settings \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
The schedule this site is checked on, which providers are asked, which metrics are rendered, and — importantly — **who is paying** for the checks. `funding` is the field to read before showing anything else. `own_key` means the checks run on a key you connected, against your own quota, and cost nothing here. `platform` means they run on Zinn®'s own accounts under your plan or add-on. `none` means no check can currently run, and `reason` says what to do about it. A site that has never been configured answers with the account defaults rather than 404 — there is nothing to create before this can be read.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
siteId (path) | Uuid | 是 | Site ID (UUIDv7). |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
cadence | string<daily, every_other_day, weekly> | 是 | How often this site is checked. Checks may not run more often than every 12 hours. |
providers | string[] | 是 | Which providers to ask, by name. Empty means "whichever of my connected keys can answer", which is the sensible setting for an account with one key. |
visible_metrics | string[] | 是 | Which metrics to render for this site. Empty means show everything available. A display choice only — hidden metrics are still measured and their history kept. |
available_metrics | string[] | 是 | Every metric the currently-funded provider can supply for this site. The set a client should offer as toggles; a metric outside it cannot be shown however it is configured, beca… |
paused | boolean | 是 | When true nothing is checked and nothing is spent. History is kept, and settings are restored untouched when it is switched back on. |
funding | string<own_key, platform, none> | 是 | Who pays for this site's checks. `own_key` — your own connected key and your own quota, free here. `platform` — Zinn®'s accounts, under your plan or add-on. `none` — nothing can… |
vendor | string | 否 | The provider actually serving this site, when one is. |
reason | string<no_key_connected, own_key_unusable, reseller_addon_required, not_entitled, not_in_good_standing> | 否 | Why no check can run, when `funding` is `none`. `own_key_unusable` means a key is stored but could not be used — usually revoked or out of quota at the provider, and Zinn® delib… |
此端点可能返回的错误
401 · 403 · 404