hosting
GET /v1/sites/{site_id}/translation
Whether this site is translated, and how far along it is.
Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione sites.view; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.
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/{site_id}/translation \
-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 state of Site Translation for one site: whether it is bought, which tier, how many words and documents we measured, when we last read the site, and per-locale progress. **A site with no subscription is a `200`, not a `404`.** The screen needs to render the offer, and "not bought" is an answer about a site that exists — returning `404` would make a site the customer owns look missing. `locales[]` reports every language with its own counts, and `served` says whether the customer has switched that language on for visitors. ⛔ `translated` and `served` are separate numbers on purpose: every tier translates every language, so a locale can be 100% translated and reach nobody because its owner has not enabled it. Merging them would report either a coverage figure nobody is served by, or a delivery figure that understates what is ready — the two mistakes `docs/28` was rewritten to stop making. Readable whether or not the account is in good standing: a customer behind on an invoice may still see what they have already paid for. Requires `sites.view`.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
site_id (path) | Uuid | Sì | — |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
site_id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
state | string<disabled, active, paused_standing, over_allowance> | Sì | ⛔ `paused_standing` is its own state, not a flavour of `disabled` — the remedies differ and only one of them is the customer's to act on. |
tier | SiteTranslationTier | Sì | — |
available_tiers | SiteTranslationTier[] | Sì | The ladder, so the screen never hardcodes a price. |
word_count | integer | Sì | Translatable words measured at the last read. |
document_count | integer | Sì | — |
last_extracted_at | string | No | When we last successfully read the site. ⛔ Distinct from the attempt cursor the sweep keeps: a failed pass advances that and must not move this, or the screen would report a sit… |
last_error | string | No | Why the last pass did nothing, in words the customer can act on. |
locales | SiteTranslationLocale[] | Sì | — |
Errori che questo endpoint può restituire
401 · 403 · 404