hosting
GET /v1/sites/{site_id}/translation
Whether this site is translated, and how far along it is.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění sites.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/sites/{site_id}/translation \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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`.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
site_id (path) | Uuid | Ano | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
site_id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
state | string<disabled, active, paused_standing, over_allowance> | Ano | ⛔ `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 | Ano | — |
available_tiers | SiteTranslationTier[] | Ano | The ladder, so the screen never hardcodes a price. |
word_count | integer | Ano | Translatable words measured at the last read. |
document_count | integer | Ano | — |
last_extracted_at | string | Ne | 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 | Ne | Why the last pass did nothing, in words the customer can act on. |
locales | SiteTranslationLocale[] | Ano | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404