hosting
GET /v1/sites/{siteId}/seo-settings
How often this site's SEO metrics are checked, and what is shown.
Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/seo-settings \
-H "Authorization: Bearer zdk_live_…"Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
siteId (path) | Uuid | Sì | Site ID (UUIDv7). |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
cadence | string<daily, every_other_day, weekly> | Sì | How often this site is checked. Checks may not run more often than every 12 hours. |
providers | string[] | Sì | 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[] | Sì | 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[] | Sì | 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 | Sì | 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> | Sì | 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 | No | 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> | No | 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… |
Errori che questo endpoint può restituire
401 · 403 · 404