Get All User Events
curl --request POST \
--url https://api.trieve.ai/api/analytics/events/all \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"date_range": {
"gt": "2021-08-10T00:00:00Z",
"lt": "2021-08-11T00:00:00Z"
},
"event_type": "view",
"is_conversion": true,
"metadata_filter": "path = \"value\"",
"user_id": "user1"
},
"page": 1
}
'import requests
url = "https://api.trieve.ai/api/analytics/events/all"
payload = {
"filter": {
"date_range": {
"gt": "2021-08-10T00:00:00Z",
"lt": "2021-08-11T00:00:00Z"
},
"event_type": "view",
"is_conversion": True,
"metadata_filter": "path = \"value\"",
"user_id": "user1"
},
"page": 1
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {
date_range: {gt: '2021-08-10T00:00:00Z', lt: '2021-08-11T00:00:00Z'},
event_type: 'view',
is_conversion: true,
metadata_filter: 'path = "value"',
user_id: 'user1'
},
page: 1
})
};
fetch('https://api.trieve.ai/api/analytics/events/all', 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/all",
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([
'filter' => [
'date_range' => [
'gt' => '2021-08-10T00:00:00Z',
'lt' => '2021-08-11T00:00:00Z'
],
'event_type' => 'view',
'is_conversion' => true,
'metadata_filter' => 'path = "value"',
'user_id' => 'user1'
],
'page' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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/all"
payload := strings.NewReader("{\n \"filter\": {\n \"date_range\": {\n \"gt\": \"2021-08-10T00:00:00Z\",\n \"lt\": \"2021-08-11T00:00:00Z\"\n },\n \"event_type\": \"view\",\n \"is_conversion\": true,\n \"metadata_filter\": \"path = \\\"value\\\"\",\n \"user_id\": \"user1\"\n },\n \"page\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
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/all")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"date_range\": {\n \"gt\": \"2021-08-10T00:00:00Z\",\n \"lt\": \"2021-08-11T00:00:00Z\"\n },\n \"event_type\": \"view\",\n \"is_conversion\": true,\n \"metadata_filter\": \"path = \\\"value\\\"\",\n \"user_id\": \"user1\"\n },\n \"page\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trieve.ai/api/analytics/events/all")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"date_range\": {\n \"gt\": \"2021-08-10T00:00:00Z\",\n \"lt\": \"2021-08-11T00:00:00Z\"\n },\n \"event_type\": \"view\",\n \"is_conversion\": true,\n \"metadata_filter\": \"path = \\\"value\\\"\",\n \"user_id\": \"user1\"\n },\n \"page\": 1\n}"
response = http.request(request)
puts response.read_body{
"events": [
{
"created_at": "2021-08-10T00:00:00Z",
"dataset_id": "00000000-0000-0000-0000-000000000000",
"event_name": "Viewed Home Page",
"event_type": "view",
"is_conversion": true,
"items": [
"item1",
"item2"
],
"metadata": "metadata",
"request_id": "00000000-0000-0000-0000-000000000000",
"updated_at": "2021-08-10T00:00:00Z",
"user_id": "user1"
}
]
}{
"message": "Bad Request"
}Analytics
Get All User Events
This route allows you to view all user events.
POST
/
api
/
analytics
/
events
/
all
Get All User Events
curl --request POST \
--url https://api.trieve.ai/api/analytics/events/all \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"date_range": {
"gt": "2021-08-10T00:00:00Z",
"lt": "2021-08-11T00:00:00Z"
},
"event_type": "view",
"is_conversion": true,
"metadata_filter": "path = \"value\"",
"user_id": "user1"
},
"page": 1
}
'import requests
url = "https://api.trieve.ai/api/analytics/events/all"
payload = {
"filter": {
"date_range": {
"gt": "2021-08-10T00:00:00Z",
"lt": "2021-08-11T00:00:00Z"
},
"event_type": "view",
"is_conversion": True,
"metadata_filter": "path = \"value\"",
"user_id": "user1"
},
"page": 1
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {
date_range: {gt: '2021-08-10T00:00:00Z', lt: '2021-08-11T00:00:00Z'},
event_type: 'view',
is_conversion: true,
metadata_filter: 'path = "value"',
user_id: 'user1'
},
page: 1
})
};
fetch('https://api.trieve.ai/api/analytics/events/all', 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/all",
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([
'filter' => [
'date_range' => [
'gt' => '2021-08-10T00:00:00Z',
'lt' => '2021-08-11T00:00:00Z'
],
'event_type' => 'view',
'is_conversion' => true,
'metadata_filter' => 'path = "value"',
'user_id' => 'user1'
],
'page' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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/all"
payload := strings.NewReader("{\n \"filter\": {\n \"date_range\": {\n \"gt\": \"2021-08-10T00:00:00Z\",\n \"lt\": \"2021-08-11T00:00:00Z\"\n },\n \"event_type\": \"view\",\n \"is_conversion\": true,\n \"metadata_filter\": \"path = \\\"value\\\"\",\n \"user_id\": \"user1\"\n },\n \"page\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
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/all")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"date_range\": {\n \"gt\": \"2021-08-10T00:00:00Z\",\n \"lt\": \"2021-08-11T00:00:00Z\"\n },\n \"event_type\": \"view\",\n \"is_conversion\": true,\n \"metadata_filter\": \"path = \\\"value\\\"\",\n \"user_id\": \"user1\"\n },\n \"page\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trieve.ai/api/analytics/events/all")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"date_range\": {\n \"gt\": \"2021-08-10T00:00:00Z\",\n \"lt\": \"2021-08-11T00:00:00Z\"\n },\n \"event_type\": \"view\",\n \"is_conversion\": true,\n \"metadata_filter\": \"path = \\\"value\\\"\",\n \"user_id\": \"user1\"\n },\n \"page\": 1\n}"
response = http.request(request)
puts response.read_body{
"events": [
{
"created_at": "2021-08-10T00:00:00Z",
"dataset_id": "00000000-0000-0000-0000-000000000000",
"event_name": "Viewed Home Page",
"event_type": "view",
"is_conversion": true,
"items": [
"item1",
"item2"
],
"metadata": "metadata",
"request_id": "00000000-0000-0000-0000-000000000000",
"updated_at": "2021-08-10T00:00:00Z",
"user_id": "user1"
}
]
}{
"message": "Bad Request"
}Authorizations
Body
application/json
JSON request payload to filter the events
Filter to apply to the events when querying for them
Show child attributes
Show child attributes
Example:
{
"date_range": {
"gt": "2021-08-10T00:00:00Z",
"lt": "2021-08-11T00:00:00Z"
},
"event_type": "view",
"is_conversion": true,
"metadata_filter": "path = \"value\"",
"user_id": "user1"
}
Page of results to return
Required range:
x >= 0Response
The events for the request
Response body for the GetEvents endpoint
Show child attributes
Show child attributes
Was this page helpful?