Skip to main content
GET
Get clusters for a job

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

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Search cluster label or pillar keyword

minKeywordCount
integer
Required range: x >= 0
maxKeywordCount
integer
Required range: x >= 0
sortBy
string
default:aggregateOpportunityScore
sortOrder
enum<string>
default:desc
Available options:
asc,
desc

Response

Paginated clusters and total count

clusters
object[]
total
integer
limit
integer
offset
integer