---
title: "Get Cluster Analytics"
method: POST
path: "/api/analytics/search/cluster"
tags: ["Analytics"]
---

# Get Cluster Analytics

`POST /api/analytics/search/cluster`

This route allows you to view the cluster analytics for a dataset.

## Headers

- `TR-Dataset` string, uuid, required

## Request body

- union
  - object
    - `filter` ClusterAnalyticsFilter
      - `date_range` DateRange — DateRange is a JSON object which can be used to filter chunks by a range of dates. This leverages the time_stamp field on chunks in your dataset. You can specify this if you want values in a certain range. You must provide ISO 8601 combined date and time without timezone.
        - `gt` string, nullable
        - `gte` string, nullable
        - `lt` string, nullable
        - `lte` string, nullable
    - `type` 'cluster_topics', required
  - object
    - `cluster_id` string, uuid, required
    - `page` integer, nullable
    - `type` 'cluster_queries', required

## Response `200`

The cluster analytics for the dataset

- union
  - SearchClusterResponse
    - `clusters` SearchClusterTopics[], required
      - `avg_score` number, float, required
      - `created_at` string, required
      - `dataset_id` string, uuid, required
      - `density` integer, required
      - `id` string, uuid, required
      - `topic` string, required
  - SearchQueryResponse
    - `queries` SearchQueryEvent[], required
      - `created_at` string, required
      - `dataset_id` string, uuid, required
      - `id` string, uuid, required
      - `latency` number, float, required
      - `metadata` unknown
      - `query` string, required
      - `query_rating` SearchQueryRating
        - `metadata` unknown
        - `note` string, nullable
        - `rating` integer, required
      - `request_params` unknown, required
      - `results` unknown[], required
        - unknown
      - `search_type` 'search' | 'search_over_groups' | 'autocomplete' | 'rag', required
      - `top_score` number, float, required
      - `user_id` string, required

## Other responses

- `400` — Service error relating to getting cluster analytics

---

[API](https://skmtc.net/devflowinc/apis/trieve-api.md) · [All operations](https://skmtc.net/devflowinc/apis/trieve-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/devflowinc/trieve-api/revisions/84583e7c9fc1/schema)