Skip to main content
POST
/
api
/
analytics
/
search
Get Search Analytics
curl --request POST \
  --url https://api.trieve.ai/api/analytics/search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '
{
  "type": "latency_graph",
  "filter": {
    "component_name": "<string>",
    "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"
    },
    "query": "<string>",
    "query_rating": {
      "gt": 1,
      "gte": 1,
      "lt": 1,
      "lte": 1
    },
    "top_score": {
      "gt": 123,
      "gte": 123,
      "lt": 123,
      "lte": 123
    }
  }
}
'
import requests

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

payload = {
    "type": "latency_graph",
    "filter": {
        "component_name": "<string>",
        "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"
        },
        "query": "<string>",
        "query_rating": {
            "gt": 1,
            "gte": 1,
            "lt": 1,
            "lte": 1
        },
        "top_score": {
            "gt": 123,
            "gte": 123,
            "lt": 123,
            "lte": 123
        }
    }
}
headers = {
    "TR-Dataset": "<tr-dataset>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'TR-Dataset': '<tr-dataset>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: 'latency_graph',
    filter: {
      component_name: '<string>',
      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'
      },
      query: '<string>',
      query_rating: {gt: 1, gte: 1, lt: 1, lte: 1},
      top_score: {gt: 123, gte: 123, lt: 123, lte: 123}
    }
  })
};

fetch('https://api.trieve.ai/api/analytics/search', 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/search",
  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([
    'type' => 'latency_graph',
    'filter' => [
        'component_name' => '<string>',
        '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'
        ],
        'query' => '<string>',
        'query_rating' => [
                'gt' => 1,
                'gte' => 1,
                'lt' => 1,
                'lte' => 1
        ],
        'top_score' => [
                'gt' => 123,
                'gte' => 123,
                'lt' => 123,
                'lte' => 123
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "TR-Dataset: <tr-dataset>"
  ],
]);

$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/search"

	payload := strings.NewReader("{\n  \"type\": \"latency_graph\",\n  \"filter\": {\n    \"component_name\": \"<string>\",\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    \"query\": \"<string>\",\n    \"query_rating\": {\n      \"gt\": 1,\n      \"gte\": 1,\n      \"lt\": 1,\n      \"lte\": 1\n    },\n    \"top_score\": {\n      \"gt\": 123,\n      \"gte\": 123,\n      \"lt\": 123,\n      \"lte\": 123\n    }\n  }\n}")

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

	req.Header.Add("TR-Dataset", "<tr-dataset>")
	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/search")
  .header("TR-Dataset", "<tr-dataset>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"latency_graph\",\n  \"filter\": {\n    \"component_name\": \"<string>\",\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    \"query\": \"<string>\",\n    \"query_rating\": {\n      \"gt\": 1,\n      \"gte\": 1,\n      \"lt\": 1,\n      \"lte\": 1\n    },\n    \"top_score\": {\n      \"gt\": 123,\n      \"gte\": 123,\n      \"lt\": 123,\n      \"lte\": 123\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["TR-Dataset"] = '<tr-dataset>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"latency_graph\",\n  \"filter\": {\n    \"component_name\": \"<string>\",\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    \"query\": \"<string>\",\n    \"query_rating\": {\n      \"gt\": 1,\n      \"gte\": 1,\n      \"lt\": 1,\n      \"lte\": 1\n    },\n    \"top_score\": {\n      \"gt\": 123,\n      \"gte\": 123,\n      \"lt\": 123,\n      \"lte\": 123\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "points": [
    {
      "point": 123,
      "time_stamp": "<string>"
    }
  ]
}
{
  "message": "Bad Request"
}

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

​
type
enum<string>
required
Available options:
latency_graph
​
filter
object | null
​
granularity
enum<string> | null
Available options:
minute,
second,
hour,
day,
month

Response

The search analytics for the dataset

​
points
object[]
required