hosting
GET /v1/sites/{site_id}/translation
Whether this site is translated, and how far along it is.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл sites.view; ключ без нього відхиляється з кодом 403, а не 404.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/sites/{site_id}/translation \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
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.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
site_id (path) | Uuid | Так | — |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
site_id | Uuid | Так | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
state | string<disabled, active, paused_standing, over_allowance> | Так | ⛔ 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 | Так | — |
available_tiers | SiteTranslationTier[] | Так | The ladder, so the screen never hardcodes a price. |
word_count | integer | Так | Translatable words measured at the last read. |
document_count | integer | Так | — |
last_extracted_at | string | Ні | 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 site… |
last_error | string | Ні | Why the last pass did nothing, in words the customer can act on. |
locales | SiteTranslationLocale[] | Так | — |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404