Skip to main content
GET
/
api
/
v1
/
jobs
/
{jobId}
Get job status and metadata
curl --request GET \
  --url https://suprkeywords.com/app/api/v1/jobs/{jobId}
{
  "id": "<string>",
  "status": "queued",
  "primaryDomain": "<string>",
  "competitorDomains": [
    "<string>"
  ],
  "languageCode": "<string>",
  "locationCode": 123,
  "progress": {},
  "errorMessage": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "totalKeywordCount": 123
}

Path Parameters

​
jobId
string<uuid>
required

Response

Job details including status, progress, totalKeywordCount when completed/failed

​
id
string
​
status
enum<string>
Available options:
queued,
running,
completed,
failed
​
primaryDomain
string
​
competitorDomains
string[]
​
languageCode
string
​
locationCode
integer
​
progress
object
​
errorMessage
string | null
​
createdAt
string<date-time>
​
startedAt
string<date-time> | null
​
completedAt
string<date-time> | null
​
totalKeywordCount
integer

Present when status is completed or failed