Get a Bot View job

Check a Bot View job: its status, how many items are done and failed, and when its results expire.

GEThttps://rankfield.dev/v1/bot-view/jobs/{id}

curl 'https://rankfield.dev/v1/bot-view/jobs/8f14e45fceea167a5a36dedd4bea2543' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

response = requests.get(
    "https://rankfield.dev/v1/bot-view/jobs/8f14e45fceea167a5a36dedd4bea2543",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
print(response.json())

const response = await fetch("https://rankfield.dev/v1/bot-view/jobs/8f14e45fceea167a5a36dedd4bea2543", {
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});
console.log(await response.json());

200

{
  "job": {
    "id": "8f14e45fceea167a5a36dedd4bea2543",
    "status": "running",
    "total": 2,
    "done": 1,
    "failed": 0,
    "createdAt": "2026-10-26T18:00:00Z",
    "finishedAt": null,
    "expiresAt": null
  }
}

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 a Bot View job.

Response

Field	Type	Description
`job.id`	string	The job id.
`job.status`	string	`queued`, `running`, `done` or `canceled`.
`job.total`	integer	URLs in the job.
`job.done`	integer	Items that succeeded.
`job.failed`	integer	Items that failed.
`job.createdAt`, `job.finishedAt`	string \| null	When it was created and when it finished (UTC).
`job.expiresAt`	string \| null	When its results are deleted: 24 hours after it finishes.

Only the key that started a job can read it; any other key gets 404.

Errors

Status	Code	When
401	`unauthorized`	No valid API key.
404		No job with this id for this key, or it has expired. This answer has no `code`: `{"error":{"message":"Not found"}}`.