Send User Event Data

PUT

api

analytics

events

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": "<any>",
  "request": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "request_type": "search"
  },
  "user_id": "<string>"
}'

This response does not have an example.

Authorizations

Authorization

string

header

required

Headers

TR-Dataset

string

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

user_id

string | null

The user id of the user who viewed the items

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

user_id

string | null

The user id of the user who viewed the items

event_name

string

required

The name of the event

event_type

enum<string>

required

Available options:

add_to_cart

items

string[]

required

The items that were added to the cart

is_conversion

boolean | null

Whether the event is a conversion event

location

string | null

The location of the event

metadata

any | null

Any other metadata associated with the event

request

object

user_id

string | null

The user id of the user who added the items to the cart

event_name

string

required

The name of the event

event_type

enum<string>

required

Available options:

click

clicked_items

object

is_conversion

boolean | null

Whether the event is a conversion event

location

string | null

The location of the event

metadata

any | null

Metadata to include with click event

request

object

user_id

string | null

The user id of the user who clicked the items

event_name

string

required

The name of the event

event_type

enum<string>

required

Available options:

purchase

items

object[]

required

The items that were purchased

is_conversion

boolean | null

Whether the event is a conversion event

location

string | null

The location of the event

metadata

any | null

Any other metadata associated with the event

request

object

user_id

string | null

The user id of the user who purchased the items

event_name

string

required

The name of the event

event_type

enum<string>

required

Available options:

filter_clicked

items

object

required

The filter items that were clicked in a hashmap ie. {filter_name: filter_value} where filter_name is filter_type::field_name

is_conversion

boolean | null

Whether the event is a conversion event

location

string | null

The location of the event

request

object

user_id

string | null

The user id of the user who clicked the items

event_type

enum<string>

required

Available options:

search

query

string

required

The search query

tokens

integer

required

Number of tokens used in the search

Required range: x >= 0

latency

number | null

Latency of the search

metadata

any | null

Metadata to provide with each request

query_rating

object

request_params

any | null

The request params of the search

results

any[] | null

The results of the search

search_type

enum<string>

Available options:

search,

search_over_groups,

autocomplete,

rag

top_score

number | null

The top score of the search

user_id

string | null

The user id of the user who made the search

event_type

enum<string>

required

Available options:

rag

tokens

integer

required

The number of tokens used for this chat

Required range: x >= 0

user_message

string

required

The user message

detected_hallucinations

string[] | null

The detected hallucinations of the RAG event

hallucination_score

number | null

The hallucination score of the RAG event

llm_response

string | null

The response from the LLM

metadata

any | null

Metadata to provide with each request

query_rating

object

rag_type

enum<string>

Available options:

chosen_chunks,

all_chunks

results

any[] | null

The results of the RAG event

search_id

string | null

The search id to associate the RAG event with a search

topic_id

string | null

The topic id to associate the RAG event with a topic

user_id

string | null

The user id of the user who made the RAG event

event_type

enum<string>

required

Available options:

recommendation

metadata

any | null

Metadata to provide with each request

negative_ids

string[] | null

Negative ids used for the recommendation

negative_tracking_ids

string[] | null

Negative tracking ids used for the recommendation

positive_ids

string[] | null

Positive ids used for the recommendation

positive_tracking_ids

string[] | null

Positive tracking ids used for the recommendation

recommendation_type

enum<string>

Available options:

Chunk,

Group

request_params

any | null

The request params of the recommendation

results

any[] | null

The results of the Recommendation event

top_score

number | null

Top score of the recommendation

user_id

string | null

The user id of the user who made the recommendation

Response

204

_mintlify/placeholder

The event data was successfully sent

Was this page helpful?

Raise issue

Get Top Datasets Send CTR 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": "<any>",
  "request": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "request_type": "search"
  },
  "user_id": "<string>"
}'

This response does not have an example.

Chunk

Chunk Group

Topic

Message

Crawl

File

Analytics

Dataset

Organization

User

Auth

Health

Invitation

Stripe

Metrics

Send User Event Data

Authorizations

Headers

Body

Response