Get Source Discovery Status
Poll the status of an async source-discovery task started by
POST /discovery/source. Poll until status is completed (then fetch
GET /discovery/source/{taskId}/results) or failed.
A one-tier sweep normally completes in a few minutes. A traversal
(traverse: true) runs for hours: about 15 minutes per round of sweeps. Poll
a traversal about every 15 minutes.
โถRequest
โถMethod & Path
GET /discovery/source/{taskId}/status
โถPath parameters
taskId(UUID, required) โ the discovery task id returned by the dispatch call. A non-UUID value is rejected with400.
โถHeaders
x-api-keyโ required.Accept: application/json
โถResponse
- 200 โ a
source_discovery_taskresource with the normalised lifecyclestatusand anerrormessage (set only whenfailed). - 400 โ
taskIdis not a valid UUID. - 401 / 403 โ missing or invalid key, or the key lacks
geocode:read. - 404 โ the task is unknown, or it belongs to a different organization
(ownership is enforced upstream and returns
404โ never403โ so a guessed id cannot be probed). - 502 โ a transient upstream failure fetching the status. Safe to retry.
โถResponse schema
| Field | Type | Description |
|---|---|---|
type | string | Always source_discovery_task. |
id | string | The discovery task id. |
attributes.status | "pending" | "processing" | "completed" | "failed" | Normalised lifecycle status. completed is reported only once the discovery sub-task has written its result blob, so a completed status is always safe to fetch results from. |
attributes.error | string | null | Failure message; null unless status is failed. |
attributes.partial_ready | boolean | true when a provisional snapshot of the running search can be fetched with โฆ/results?partial=true. |
attributes.generation | number | Rises with each snapshot; 0 when none has been published. Pass the last one read as since_generation. |
attributes.provisional_count | number | null | Candidates in the newest snapshot. null when the discovery service did not report it. |
attributes.traverse | boolean, optional | true when the task is a supply-graph traversal. Poll it about every 15 minutes. Absent when the discovery service did not report it. |
links.results | string | URL to fetch the discovered locations. |
Required scope:
geocode:read