Get Component Analytics

This route allows you to view the component analytics for a dataset.

POST /api/analytics/events/component

Get Component Analytics

cURL

curl --request POST \
  --url https://api.trieve.ai/api/analytics/events/component \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '
{
  "type": "total_unique_users",
  "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"
    }
  }
}
'

import requests

url = "https://api.trieve.ai/api/analytics/events/component"

payload = {
    "type": "total_unique_users",
    "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"
        }
    }
}
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: 'total_unique_users',
    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'
      }
    }
  })
};

fetch('https://api.trieve.ai/api/analytics/events/component', 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/events/component",
  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' => 'total_unique_users',
    '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'
        ]
    ]
  ]),
  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/events/component"

	payload := strings.NewReader("{\n  \"type\": \"total_unique_users\",\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  }\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/events/component")
  .header("TR-Dataset", "<tr-dataset>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"total_unique_users\",\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  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"total_unique_users\",\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  }\n}"

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

200

{
  "points": [
    {
      "point": 123,
      "time_stamp": "<string>"
    }
  ],
  "total_unique_users": 1
}

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

TotalUniqueUsers

TopPages

TopComponents

ComponentNames

ComponentInteractionTime

type · enum<string> · required

Available options: total_unique_users

filter · object | null

Show child attributes

granularity · enum<string> | null

Available options: minute, second, hour, day, month

Response

200

application/json

The component analytics for the dataset

Option 1

Option 2

Option 3

Option 4

Option 5

points · object[] · required

Show child attributes

total_unique_users · integer<int64> · required

Required range: x >= 0