Clusters

Cluster Visualization Data

Changed on

Return sampled visualization coordinates for rendering a cluster scatter plot. Returns all centroids plus a random sample of members (default 10,000). Only the fields needed for rendering are returned, keeping the payload small.

get/v1/clusters/{cluster_id}/visualization

Request

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

Path parameters

cluster_idstring required

Cluster ID

Query parameters

max_pointsinteger

Max member points to return

centroids_onlyboolean

Return only centroid points (fast initial load for large clusters)

compactboolean

Return members as parallel arrays (x[], y[], z[], cluster_ids[], document_ids[]) instead of array-of-objects. ~60% smaller JSON for large point counts. Centroids are still returned as objects.

run_idstring

Return the scatter for a SPECIFIC run instead of the current one. The output collection only ever holds the latest run's points, so per-run points are served from that run's stored artifact. Used by Studio's run-compare; omit for the current run (default).

Response

Successful Response

unknown required

Changes

  • 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

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API