Analytics
Get Cluster Analytics
Chunk
- POSTCreate or Upsert Chunk or Chunks
- POSTSearch
- POSTAutocomplete
- POSTGet Recommended Chunks
- POSTScroll Chunks
- POSTCount chunks above threshold
- POSTGenerate suggested queries
- POSTRAG on Specified Chunks
- PUTUpdate Chunk
- PUTUpdate Chunk By Tracking Id
- GETGet Chunk By Id
- GETGet Chunk By Tracking Id
- POSTGet Chunks By Tracking Ids
- POSTGet Chunks By Ids
- DELDelete Chunk
- DELDelete Chunk By Tracking Id
- DELBulk Delete Chunks
- POSTSplit HTML Content into Chunks
Chunk Group
- POSTCreate or Upsert Group or Groups
- POSTSearch Over Groups
- POSTSearch Within Group
- POSTGet Recommended Groups
- POSTAdd Chunk to Group
- POSTAdd Chunk to Group by Tracking ID
- POSTGet Groups for Chunks
- GETGet Chunks in Group by Tracking ID
- GETGet Group by Tracking ID
- PUTUpdate Group
- DELRemove Chunk from Group
- DELDelete Group by Tracking ID
- DELDelete Group
- GETGet Group
- GETGet Chunks in Group
- GETGet Groups for Dataset
Message
Analytics
Dataset
- POSTCreate Dataset
- POSTBatch Create Datasets
- PUTUpdate Dataset by ID or Tracking ID
- DELDelete Dataset
- DELDelete Dataset by Tracking ID
- PUTClear Dataset
- GETGet Dataset By ID
- GETGet Dataset by Tracking ID
- POSTGet All Tags
- POSTGet events for the dataset
- GETGet Datasets from Organization
- GETGet Usage By Dataset ID
- GETGet Dataset Crawl Options
- GETGet apipublic page
Organization
Health
Stripe
Metrics
Analytics
Get Cluster Analytics
This route allows you to view the cluster analytics for a dataset.
POST
/
api
/
analytics
/
search
/
cluster
Authorization
string
*
Authorization
Required
string
TR-Dataset
string
*
TR-Dataset
Required
string
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.
ClusterTopics · object
*
filter
object
filter
object
date_range
object
date_range
object
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.
Add Example Value
gt
string
gt
string
gte
string
gte
string
lt
string
lt
string
lte
string
lte
string
type
enum<string>
*
type
Required
enum<string>
Authorizations
Authorization
string
headerrequiredHeaders
TR-Dataset
string
requiredThe 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
filter
object
type
enum<string>
requiredAvailable options:
cluster_topics
Response
200 - application/json
clusters
object[]
required