hosting
GET /v1/sites/{site_id}/translation
Whether this site is translated, and how far along it is.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{site_id}/translation \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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 sit… |
last_error | string | いいえ | Why the last pass did nothing, in words the customer can act on. |
locales | SiteTranslationLocale[] | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404