Send User Event Data

curl --request PUT \
  --url https://api.trieve.ai/api/analytics/events \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '
{
  "event_name": "<string>",
  "event_type": "view",
  "items": [
    "<string>"
  ],
  "location": "<string>",
  "metadata": "<unknown>",
  "request": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "user_id": "<string>"
}
'

import requests

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

payload = {
    "event_name": "<string>",
    "event_type": "view",
    "items": ["<string>"],
    "location": "<string>",
    "metadata": "<unknown>",
    "request": { "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" },
    "user_id": "<string>"
}
headers = {
    "TR-Dataset": "<tr-dataset>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'TR-Dataset': '<tr-dataset>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    event_name: '<string>',
    event_type: 'view',
    items: ['<string>'],
    location: '<string>',
    metadata: '<unknown>',
    request: {request_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
    user_id: '<string>'
  })
};

fetch('https://api.trieve.ai/api/analytics/events', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'event_name' => '<string>',
    'event_type' => 'view',
    'items' => [
        '<string>'
    ],
    'location' => '<string>',
    'metadata' => '<unknown>',
    'request' => [
        'request_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'user_id' => '<string>'
  ]),
  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"

	payload := strings.NewReader("{\n  \"event_name\": \"<string>\",\n  \"event_type\": \"view\",\n  \"items\": [\n    \"<string>\"\n  ],\n  \"location\": \"<string>\",\n  \"metadata\": \"<unknown>\",\n  \"request\": {\n    \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"user_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.trieve.ai/api/analytics/events")
  .header("TR-Dataset", "<tr-dataset>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_name\": \"<string>\",\n  \"event_type\": \"view\",\n  \"items\": [\n    \"<string>\"\n  ],\n  \"location\": \"<string>\",\n  \"metadata\": \"<unknown>\",\n  \"request\": {\n    \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"user_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["TR-Dataset"] = '<tr-dataset>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_name\": \"<string>\",\n  \"event_type\": \"view\",\n  \"items\": [\n    \"<string>\"\n  ],\n  \"location\": \"<string>\",\n  \"metadata\": \"<unknown>\",\n  \"request\": {\n    \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"user_id\": \"<string>\"\n}"

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

{
  "message": "Bad Request"
}

PUT

api

analytics

events

Send User Event Data

curl --request PUT \
  --url https://api.trieve.ai/api/analytics/events \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '
{
  "event_name": "<string>",
  "event_type": "view",
  "items": [
    "<string>"
  ],
  "location": "<string>",
  "metadata": "<unknown>",
  "request": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "user_id": "<string>"
}
'

import requests

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

payload = {
    "event_name": "<string>",
    "event_type": "view",
    "items": ["<string>"],
    "location": "<string>",
    "metadata": "<unknown>",
    "request": { "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" },
    "user_id": "<string>"
}
headers = {
    "TR-Dataset": "<tr-dataset>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'TR-Dataset': '<tr-dataset>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    event_name: '<string>',
    event_type: 'view',
    items: ['<string>'],
    location: '<string>',
    metadata: '<unknown>',
    request: {request_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
    user_id: '<string>'
  })
};

fetch('https://api.trieve.ai/api/analytics/events', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'event_name' => '<string>',
    'event_type' => 'view',
    'items' => [
        '<string>'
    ],
    'location' => '<string>',
    'metadata' => '<unknown>',
    'request' => [
        'request_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'user_id' => '<string>'
  ]),
  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"

	payload := strings.NewReader("{\n  \"event_name\": \"<string>\",\n  \"event_type\": \"view\",\n  \"items\": [\n    \"<string>\"\n  ],\n  \"location\": \"<string>\",\n  \"metadata\": \"<unknown>\",\n  \"request\": {\n    \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"user_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.trieve.ai/api/analytics/events")
  .header("TR-Dataset", "<tr-dataset>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_name\": \"<string>\",\n  \"event_type\": \"view\",\n  \"items\": [\n    \"<string>\"\n  ],\n  \"location\": \"<string>\",\n  \"metadata\": \"<unknown>\",\n  \"request\": {\n    \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"user_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["TR-Dataset"] = '<tr-dataset>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_name\": \"<string>\",\n  \"event_type\": \"view\",\n  \"items\": [\n    \"<string>\"\n  ],\n  \"location\": \"<string>\",\n  \"metadata\": \"<unknown>\",\n  \"request\": {\n    \"request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"user_id\": \"<string>\"\n}"

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

{
  "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 send event data

event_name

string

required

The name of the event

event_type

enum<string>

required

Available options:

view

items

string[]

required

The items that were viewed

location

string | null

The location of the event

metadata

any | null

Any other metadata associated with the event

request

object | null

Show child attributes

user_id

string | null

The user id of the user who viewed the items

Response

The event data was successfully sent

Chunk

Chunk Group

Topic

Message

Crawl

File

Analytics

Experiments

Dataset

Organization

User

Auth

Health

Invitation

Stripe

Metrics

Public

Send User Event Data

Authorizations

Headers

Body

Response