POST
/
api
/
analytics
/
search
/
cluster
Get Cluster Analytics
curl --request POST \
  --url https://api.trieve.ai/api/analytics/search/cluster \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "filter": {
    "date_range": {
      "gt": "2021-01-01 00:00:00.000",
      "gte": "2021-01-01 00:00:00.000",
      "lt": "2021-01-01 00:00:00.000",
      "lte": "2021-01-01 00:00:00.000"
    }
  },
  "type": "cluster_topics"
}'
{
  "clusters": [
    {
      "avg_score": 123,
      "created_at": "<string>",
      "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "density": 123,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "topic": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Headers

​
TR-Dataset
string<uuid>
required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Body

application/json

JSON request payload to filter the graph

The body is of type object.

Response

200
application/json

The cluster analytics for the dataset

The response is of type object.