Skip to main content
GET
/
api
/
v1
/
jobs
/
{jobId}
/
summary
Get job results summary
curl --request GET \
  --url https://www.suprkeywords.com/api/v1/jobs/{jobId}/summary \
  --header 'Authorization: Bearer <token>'
{
  "personaCount": 123,
  "referenceCount": 123,
  "keywordCount": 123,
  "enrichedKeywordCount": 123,
  "clusterCount": 123,
  "totalOpportunityValue": 123,
  "totalSearchVolume": 123,
  "avgSearchVolume": 123,
  "avgDifficulty": 123,
  "avgCpc": 123,
  "avgCompetition": 123,
  "intentCounts": {},
  "personaCounts": [
    {
      "personaId": "<string>",
      "avatarName": "<string>",
      "name": "<string>",
      "count": 123
    }
  ],
  "monthlyVolumeByMonth": [
    {
      "month": "<string>",
      "volume": 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 summary stats

personaCount
integer
referenceCount
integer
keywordCount
integer
enrichedKeywordCount
integer
clusterCount
integer
totalOpportunityValue
number
totalSearchVolume
integer
avgSearchVolume
number | null
avgDifficulty
number | null
avgCpc
number | null
avgCompetition
number | null
intentCounts
object
personaCounts
object[]
monthlyVolumeByMonth
object[]