Skip to main content
GET
/
browser
/
v1
/
crawl
/
{id}
Get a crawl job
curl --request GET \
  --url https://api.voyant.travel/browser/v1/crawl/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "kind": "crawl",
  "inputUrl": "<string>",
  "browserMsUsed": 123,
  "resultSummary": {
    "total": 123,
    "finished": 123,
    "errored": 123,
    "cursor": "<string>"
  },
  "errorMessage": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Voyant Cloud API token, passed as Authorization: Bearer <token>. Each token carries a fixed set of scopes; an operation rejects tokens missing its required scope.

Path Parameters

​
id
string
required

Response

Crawl summary

​
id
string
required
​
kind
enum<string>
required
Available options:
crawl
​
status
enum<string>
required
Available options:
queued,
running,
completed,
errored,
cancelled_due_to_timeout,
cancelled_due_to_limits,
cancelled_by_user
​
inputUrl
string
required
​
browserMsUsed
integer
required
​
resultSummary
object
required
​
errorMessage
string | null
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
completedAt
string<date-time> | null
required