認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/site-imports/{importId} \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
A pure database read — everything reported comes from rows the workflow writes, so polling costs no archive call. Progress is per-URL counters rather than only a percentage, because "which step" is the useful answer when a customer asks why a restore is slow. `budget_exhausted` is surfaced deliberately: a job that stopped because it ran out of requests otherwise looks exactly like one that finished. Requires `sites.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
importId (path) | Uuid | はい | Site-import job ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | string | いいえ | The site this import lands on, or empty. Empty is a real outcome, not an error: an aged-domain restore produces a downloadable bundle and the customer picks the target afterwards. |
source | SiteImportSource | はい | Where the content comes from. ⛔ Deliberately not the same enum as a site's `source`: that one records what a site was built from, for ever, while this selects a fetch strategy a… |
output | SiteImportOutput | はい | What the import produces. Both are supported; neither is a default. |
status | SiteImportStatus | はい | `fetching` and `building` are separate states rather than one `running` because they fail for opposite reasons and the customer's next action differs — a stall in `fetching` is… |
status_reason | string | いいえ | A machine code the dashboard renders through its own catalogue — never an English sentence composed by the engine, which could not be shown to the other 57 locales. |
source_domain | string | はい | — |
target_domain | string | いいえ | — |
snapshot_day | string | いいえ | — |
crawl_depth | integer | いいえ | — |
urls_total | integer | はい | — |
urls_done | integer | はい | — |
urls_failed | integer | はい | — |
progress_percent | integer | はい | For a progress bar only. The per-URL counters are the primary display, because a percentage cannot say *which* step. |
requests_spent | integer | はい | — |
request_budget | integer | はい | — |
budget_exhausted | boolean | はい | True when the job stopped because it ran out of requests. Surfaced deliberately — it otherwise looks identical to a job that finished, and the customer's next action depends on… |
bundle_bytes | integer | いいえ | — |
created_at | string | はい | — |
started_at | string | いいえ | — |
finished_at | string | いいえ | — |
can_cancel | boolean | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 429