Get a suggest job

Check a suggest job's status and how many of its keywords are done, succeeded and failed.

GEThttps://rankfield.dev/v1/bing/suggest/jobs/{id}

curl 'https://rankfield.dev/v1/bing/suggest/jobs/1e3aff33-2831-4112-b934-cb727ab6c23a' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

response = requests.get(
    "https://rankfield.dev/v1/bing/suggest/jobs/1e3aff33-2831-4112-b934-cb727ab6c23a",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
print(response.json())

const response = await fetch("https://rankfield.dev/v1/bing/suggest/jobs/1e3aff33-2831-4112-b934-cb727ab6c23a", {
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});
console.log(await response.json());

200

{
  "id": "1e3aff33-2831-4112-b934-cb727ab6c23a",
  "status": "completed",
  "total": 2,
  "completed": 2,
  "succeeded": 2,
  "failed": 0,
  "createdAt": 1792938856915,
  "deadlineAt": 1792938916915,
  "completedAt": 1792938857066,
  "delivery": "priority",
  "keywordCount": 2,
  "workUnits": 2
}

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 suggest job.

Response

Field	Type	Description
`id`	string	The job id.
`status`	string	`running`, `completed` or `cancelled`.
`total`	integer	Keywords in the job.
`completed`, `succeeded`, `failed`	integer	Keywords finished, and how they ended.
`createdAt`, `deadlineAt`, `completedAt`	integer \| null	Milliseconds since 1970 (UTC). `completedAt` is `null` while running.
`delivery`	string	The deadline tier.
`keywordCount`, `workUnits`	integer	What the job counts against your daily keywords.

You don't need to wait for completed: Get suggest job results returns keywords as they finish.

Errors

Status	When
401	No valid API key.
404	No job with this id for this key.