Skip to main content
GET
/
v1
/
clusters
/
{cluster_id}
/
groups
List Cluster Groups
curl --request GET \
  --url https://api.mixpeek.com/v1/clusters/{cluster_id}/groups \
  --header 'Authorization: Bearer <token>'
{
  "cluster_id": "<string>",
  "total_groups": 123,
  "total_documents": 123,
  "groups": [
    {
      "cluster_id": "<string>",
      "member_count": 123,
      "label": "<string>",
      "summary": "<string>",
      "keywords": [
        "<string>"
      ]
    }
  ],
  "run_id": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id
string
required

Cluster ID

Response

Successful Response

Response containing all groups for a cluster.

cluster_id
string
required
total_groups
integer
required
total_documents
integer
required
groups
ClusterGroup · object[]
required
run_id
string | null