Clusters

Keyword cluster management

Generate a content cluster

post

Create an interlinked content cluster with a pillar article and supporting articles. All articles are automatically interlinked using Link Engine. Requires Power plan or higher and Link Engine to be configured.

Authorizations
X-API-KEYstringRequired
Body
site_idstring · uuidRequired
pillar_keywordstring · max: 200Required

The main topic/keyword for the pillar article

pillar_titlestring · max: 200Optional

Optional custom title for pillar article

pillar_secondary_keywordsstring[] · max: 5Optional
supporting_keywordsstring[] · min: 1 · max: 10Required

Keywords for supporting articles that link to the pillar

Responses
post
/v1/clusters/generate
202

Cluster generation started

List keyword clusters

get

Returns keyword clusters for content planning. Requires Power plan or higher.

Authorizations
X-API-KEYstringRequired
Query parameters
pageintegerOptional
sitestring · uuidOptional

Filter by site ID

in_planbooleanOptional

Filter by active clusters

Responses
chevron-right
200

A list of clusters

application/json
get
/v1/clusters
200

A list of clusters

Get a cluster with keywords

get
Authorizations
X-API-KEYstringRequired
Path parameters
idstring · uuidRequired

The cluster ID

Responses
chevron-right
200

Cluster with keywords

application/json
get
/v1/clusters/{id}
200

Cluster with keywords

Activate a cluster

post

Mark a cluster as "In Plan" for content planning. Requires Power plan or higher.

Authorizations
X-API-KEYstringRequired
Path parameters
idstring · uuidRequired

The cluster ID

Responses
chevron-right
200

Cluster activated

application/json
post
/v1/clusters/{id}/activate
200

Cluster activated

Deactivate a cluster

post

Remove a cluster from "In Plan". Requires Power plan or higher.

Authorizations
X-API-KEYstringRequired
Path parameters
idstring · uuidRequired

The cluster ID

Responses
chevron-right
200

Cluster deactivated

application/json
post
/v1/clusters/{id}/deactivate
200

Cluster deactivated

Last updated

Was this helpful?