v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Clusters

Cluster Visualization Data

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

Path parameters

cluster_idstring required

Cluster ID

Cluster ID

Query parameters

max_pointsinteger

Max member points to return

Max member points to return

centroids_onlyboolean

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

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.

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).

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

{"stackTrail":"paths:/v1/clusters/{cluster_id}/visualization:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}