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
- POSTAutocomplete Search 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
Crawl
File
Analytics
Dataset
- POSTCreate Dataset
- POSTBatch Create Datasets
- POSTGet All Tags
- POSTGet events for the dataset
- PUTUpdate Dataset by ID or Tracking ID
- PUTClear Dataset
- GETGet Dataset By ID
- GETGet Dataset by Tracking ID
- GETGet Datasets from Organization
- POSTCreate ETL Job
- PUTCreate Pagefind Index for Dataset
- GETGet Pagefind Index Url for Dataset
- GETGet Usage By Dataset ID
- GETGet dataset crawl options
- DELDelete Dataset
- DELDelete Dataset by Tracking ID
- POSTClone Dataset
- GETGet file and chunk creation queue lengths
Organization
Health
Stripe
Metrics
Get Analytics
Copy
curl --request POST \
--url https://api.trieve.ai/api/analytics \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TR-Dataset: <tr-dataset>' \
--data '{
"columns": [
{
"name": "<string>",
"aggregation": "SUM",
"alias": "<string>",
"distinct": true
}
],
"table": "search_queries",
"cte_query": {
"alias": "<string>",
"query": {
"columns": [
{
"name": "<string>",
"aggregation": "SUM",
"alias": "<string>",
"distinct": true
}
],
"table": "search_queries",
"expressions": [
{
"expression": {
"name": "<string>",
"type": "column"
},
"alias": "<string>"
}
],
"filter_conditions": [
{
"column": "<string>",
"operator": "=",
"value": "<string>",
"and_filter": [
"<unknown>"
],
"or_filter": [
"<unknown>"
]
}
],
"group_by": {
"columns": [
"<string>"
],
"having": {
"column": "<string>",
"function": "SUM",
"operator": "=",
"type": "aggregate",
"value": "<string>"
}
},
"joins": [
{
"condition": {
"left_column": "<string>",
"right_column": "<string>",
"type": "column_equals"
},
"table": "search_queries",
"join_type": "inner"
}
],
"limit": 1,
"offset": 1,
"order_by": {
"columns": [
"<string>"
],
"direction": "asc"
}
}
},
"expressions": [
{
"expression": {
"name": "<string>",
"type": "column"
},
"alias": "<string>"
}
],
"filter_conditions": [
{
"column": "<string>",
"operator": "=",
"value": "<string>",
"and_filter": [
"<unknown>"
],
"or_filter": [
"<unknown>"
]
}
],
"group_by": {
"columns": [
"<string>"
],
"having": {
"column": "<string>",
"function": "SUM",
"operator": "=",
"type": "aggregate",
"value": "<string>"
}
},
"joins": [
{
"condition": {
"left_column": "<string>",
"right_column": "<string>",
"type": "column_equals"
},
"table": "search_queries",
"join_type": "inner"
}
],
"limit": 1,
"offset": 1,
"order_by": {
"columns": [
"<string>"
],
"direction": "asc"
}
}'Analytics
Get Analytics
This route allows you to view the analytics for a dataset using a structured query.
POST
/
api
/
analytics
Get Analytics
Copy
curl --request POST \
--url https://api.trieve.ai/api/analytics \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TR-Dataset: <tr-dataset>' \
--data '{
"columns": [
{
"name": "<string>",
"aggregation": "SUM",
"alias": "<string>",
"distinct": true
}
],
"table": "search_queries",
"cte_query": {
"alias": "<string>",
"query": {
"columns": [
{
"name": "<string>",
"aggregation": "SUM",
"alias": "<string>",
"distinct": true
}
],
"table": "search_queries",
"expressions": [
{
"expression": {
"name": "<string>",
"type": "column"
},
"alias": "<string>"
}
],
"filter_conditions": [
{
"column": "<string>",
"operator": "=",
"value": "<string>",
"and_filter": [
"<unknown>"
],
"or_filter": [
"<unknown>"
]
}
],
"group_by": {
"columns": [
"<string>"
],
"having": {
"column": "<string>",
"function": "SUM",
"operator": "=",
"type": "aggregate",
"value": "<string>"
}
},
"joins": [
{
"condition": {
"left_column": "<string>",
"right_column": "<string>",
"type": "column_equals"
},
"table": "search_queries",
"join_type": "inner"
}
],
"limit": 1,
"offset": 1,
"order_by": {
"columns": [
"<string>"
],
"direction": "asc"
}
}
},
"expressions": [
{
"expression": {
"name": "<string>",
"type": "column"
},
"alias": "<string>"
}
],
"filter_conditions": [
{
"column": "<string>",
"operator": "=",
"value": "<string>",
"and_filter": [
"<unknown>"
],
"or_filter": [
"<unknown>"
]
}
],
"group_by": {
"columns": [
"<string>"
],
"having": {
"column": "<string>",
"function": "SUM",
"operator": "=",
"type": "aggregate",
"value": "<string>"
}
},
"joins": [
{
"condition": {
"left_column": "<string>",
"right_column": "<string>",
"type": "column_equals"
},
"table": "search_queries",
"join_type": "inner"
}
],
"limit": 1,
"offset": 1,
"order_by": {
"columns": [
"<string>"
],
"direction": "asc"
}
}'Authorizations
Headers
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
Represents a complete Analytics query with parameters
Available options:
search_queries Show child attributes
Show child attributes
Represents a complete ClickHouse query with parameters
Show child attributes
Show child attributes
Available options:
search_queries Complex expressions to select
Show child attributes
Show child attributes
WHERE clause conditions
Show child attributes
Show child attributes
Available options:
=, !=, <>, >, <, >=, <=, like, not like, in, not in, is null, is not null Show child attributes
Show child attributes
Show child attributes
Show child attributes
Represents a GROUP BY clause
Show child attributes
Show child attributes
Structured HAVING condition
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Available options:
SUM, COUNT, AVG, MIN, MAX Available options:
=, !=, <>, >, <, >=, <=, like, not like, in, not in, is null, is not null Available options:
aggregate Tables to join with
Show child attributes
Show child attributes
Available options:
search_queries Represents the type of join between tables
Available options:
inner, left, right, full, cross, anti LIMIT clause
Required range:
x >= 0OFFSET clause
Required range:
x >= 0Complex expressions to select
WHERE clause conditions
Show child attributes
Show child attributes
Available options:
=, !=, <>, >, <, >=, <=, like, not like, in, not in, is null, is not null Show child attributes
Show child attributes
Show child attributes
Show child attributes
Represents a GROUP BY clause
Show child attributes
Show child attributes
Structured HAVING condition
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Available options:
SUM, COUNT, AVG, MIN, MAX Available options:
=, !=, <>, >, <, >=, <=, like, not like, in, not in, is null, is not null Available options:
aggregate Tables to join with
Show child attributes
Show child attributes
Available options:
search_queries Represents the type of join between tables
Available options:
inner, left, right, full, cross, anti LIMIT clause
Required range:
x >= 0OFFSET clause
Required range:
x >= 0Response
200 - application/json
The analytics for the dataset
Was this page helpful?
⌘I