hosting

GET `/v1/site-imports/{importId}`

One import job's state and progress.

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس sites.view اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

curl -X GET https://api.zinndigital.com/v1/site-imports/{importId} \
  -H "Authorization: Bearer zdk_live_…"

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو 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

GET /v1/site-imports/{importId}