Get Top Datasets

curl --request POST \
  --url https://api.trieve.ai/api/analytics/top \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Organization: <tr-organization>' \
  --data '
{
  "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"
  }
}
'

import requests

url = "https://api.trieve.ai/api/analytics/top"

payload = { "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"
    } }
headers = {
    "TR-Organization": "<tr-organization>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'TR-Organization': '<tr-organization>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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'
    }
  })
};

fetch('https://api.trieve.ai/api/analytics/top', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trieve.ai/api/analytics/top",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "TR-Organization: <tr-organization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trieve.ai/api/analytics/top"

	payload := strings.NewReader("{\n  \"date_range\": {\n    \"gt\": \"2021-01-01 00:00:00.000\",\n    \"gte\": \"2021-01-01 00:00:00.000\",\n    \"lt\": \"2021-01-01 00:00:00.000\",\n    \"lte\": \"2021-01-01 00:00:00.000\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("TR-Organization", "<tr-organization>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.trieve.ai/api/analytics/top")
  .header("TR-Organization", "<tr-organization>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"date_range\": {\n    \"gt\": \"2021-01-01 00:00:00.000\",\n    \"gte\": \"2021-01-01 00:00:00.000\",\n    \"lt\": \"2021-01-01 00:00:00.000\",\n    \"lte\": \"2021-01-01 00:00:00.000\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trieve.ai/api/analytics/top")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["TR-Organization"] = '<tr-organization>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"date_range\": {\n    \"gt\": \"2021-01-01 00:00:00.000\",\n    \"gte\": \"2021-01-01 00:00:00.000\",\n    \"lt\": \"2021-01-01 00:00:00.000\",\n    \"lte\": \"2021-01-01 00:00:00.000\"\n  }\n}"

response = http.request(request)
puts response.read_body

[
  {
    "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "total_queries": 123,
    "dataset_tracking_id": "<string>"
  }
]

{
  "message": "Bad Request"
}

POST

api

analytics

top

Get Top Datasets

curl --request POST \
  --url https://api.trieve.ai/api/analytics/top \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Organization: <tr-organization>' \
  --data '
{
  "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"
  }
}
'

import requests

url = "https://api.trieve.ai/api/analytics/top"

payload = { "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"
    } }
headers = {
    "TR-Organization": "<tr-organization>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'TR-Organization': '<tr-organization>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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'
    }
  })
};

fetch('https://api.trieve.ai/api/analytics/top', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trieve.ai/api/analytics/top",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "TR-Organization: <tr-organization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trieve.ai/api/analytics/top"

	payload := strings.NewReader("{\n  \"date_range\": {\n    \"gt\": \"2021-01-01 00:00:00.000\",\n    \"gte\": \"2021-01-01 00:00:00.000\",\n    \"lt\": \"2021-01-01 00:00:00.000\",\n    \"lte\": \"2021-01-01 00:00:00.000\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("TR-Organization", "<tr-organization>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.trieve.ai/api/analytics/top")
  .header("TR-Organization", "<tr-organization>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"date_range\": {\n    \"gt\": \"2021-01-01 00:00:00.000\",\n    \"gte\": \"2021-01-01 00:00:00.000\",\n    \"lt\": \"2021-01-01 00:00:00.000\",\n    \"lte\": \"2021-01-01 00:00:00.000\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trieve.ai/api/analytics/top")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["TR-Organization"] = '<tr-organization>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"date_range\": {\n    \"gt\": \"2021-01-01 00:00:00.000\",\n    \"gte\": \"2021-01-01 00:00:00.000\",\n    \"lt\": \"2021-01-01 00:00:00.000\",\n    \"lte\": \"2021-01-01 00:00:00.000\"\n  }\n}"

response = http.request(request)
puts response.read_body

[
  {
    "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "total_queries": 123,
    "dataset_tracking_id": "<string>"
  }
]

{
  "message": "Bad Request"
}

Authorizations

Authorization

string

header

required

Headers

TR-Organization

string<uuid>

required

The organization id to use for the request

Body

application/json

JSON request payload to filter the top datasets

type

enum<string>

required

Available options:

search,

rag,

recommendation

date_range

object | null

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.

Show child attributes

Example:

{
  "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"
}

Response

The top datasets for the request

dataset_id

string<uuid>

required

total_queries

integer<int64>

required

dataset_tracking_id

string | null

Chunk

Chunk Group

Topic

Message

Crawl

File

Analytics

Experiments

Dataset

Organization

User

Auth

Health

Invitation

Stripe

Metrics

Public

Get Top Datasets

Authorizations

Headers

Body

Response