hosting

GET /v1/site-imports/{importId}

One import job's state and progress.

Všechny koncové body hosting

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/site-imports/{importId} \
  -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

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`.

Parametry

NázevTypPožadovánoCo to je
importId (path)UuidAnoSite-import job ID (UUIDv7).

Odpověď

NázevTypPožadovánoCo to je
idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idstringNeThe 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.
sourceSiteImportSourceAnoWhere 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…
outputSiteImportOutputAnoWhat the import produces. Both are supported; neither is a default.
statusSiteImportStatusAno`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_reasonstringNeA 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_domainstringAno
target_domainstringNe
snapshot_daystringNe
crawl_depthintegerNe
urls_totalintegerAno
urls_doneintegerAno
urls_failedintegerAno
progress_percentintegerAnoFor a progress bar only. The per-URL counters are the primary display, because a percentage cannot say *which* step.
requests_spentintegerAno
request_budgetintegerAno
budget_exhaustedbooleanAnoTrue 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_bytesintegerNe
created_atstringAno
started_atstringNe
finished_atstringNe
can_cancelbooleanAno

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 429