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,… |
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®… |
Грешке које ова крајња тачка може вратити
401 · 403 · 404