Skip to main content
GET
/
api
/
v1
/
jobs
/
{jobId}
Get job status and metadata
curl --request GET \
  --url https://www.suprkeywords.com/api/v1/jobs/{jobId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.suprkeywords.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key for programmatic access. Create keys in Settings (Agency plan). Send as Authorization: Bearer or X-API-KEY: . Unauthenticated requests return 401.

Path Parameters

​
jobId
string<uuid>
required

Response

Job details including status, progress, and current totalKeywordCount (updated after each pipeline step)

​
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

Current total keyword count from DB (updated after each step