Clusters

List Cluster Groups

Changed on

Get all cluster groups with labels, summaries, and document counts from the latest execution.

get/v1/clusters/{cluster_id}/groups

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/clusters/{cluster_id}/groups
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

cluster_idstring required

Cluster ID

Response

Successful Response

cluster_idstring required
run_idstring nullable
total_groupsinteger required
total_documentsinteger required
member_counts_staleboolean

True when member documents were deleted after this run completed, so member_count counts some documents that no longer exist. Re-run the cluster for current counts.

Changes

  • 62302d591b8eRevision changes
    • info

      added the optional property to the response with the status

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status