Get an export job
Check an export job's progress and, once it is complete, its row count, file parts, checksums and download link.
GEThttps://rankfield.dev/v1/jobs/{id}
Parameters
Headers
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
Authorization | string | Yes | – | Bearer followed by your API key. See Authentication. |
Path parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | – | The job id from Start an export job. |
Response
| Field | Type | Description |
|---|---|---|
status | string | queued, running, completed, failed or cancelled. |
inGraph | boolean | Only when the domain isn't in our link graph yet: false, and the export has no rows. Absent otherwise. |
scannedRelationships | integer | How much of the list has been read so far, out of totalGraphRelationships. |
exportedRows | integer | Rows written so far (after minSiteStrength). |
error | string | null | Why the job failed. |
result | object | null | Once completed: the file's rowCount, byteCount, parts (each with rows, bytes and sha256) and partsDigestSha256. |
downloadUrl | string | Once completed: the whole file in one download. |
partUrlTemplate | string | Once completed: one part at a time; replace {index}. |
Download the file
GET /v1/jobs/{id}/download streams every part as one file. For very large exports, download /v1/jobs/{id}/parts/{index} one by one and check each part's sha256, so a broken connection only costs one part.
Both answer 409 until the job is completed.
Cancel or resume
DELETE /v1/jobs/{id}cancels a queued or running job (409once it has finished).POST /v1/jobs/{id}/resumerestarts afailedjob from where it stopped.
Errors
| Status | When |
|---|---|
| 401 | No valid API key. |
| 404 | No job with this id for this key, or it has expired. |
| 409 | Download or cancel of a job in the wrong state. |
MCP
On the MCP server, the tool for this is get_export_job.