Event Streaming API
curl --request POST \
--url https://api.example.com/v1/events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"event_name": "<string>",
"event_source": "WEB",
"event_data": {
"client_id": "<string>",
"page_location": "<string>",
"session_id": "<string>",
"user_agent": "<string>",
"page_referrer": "<string>"
},
"event_metadata": {
"idempotency_key": "<string>",
"identifiers": {
"user": "<string>",
"organization": "<string>"
},
"consent": {}
}
}
]
'import requests
url = "https://api.example.com/v1/events"
payload = [
{
"event_name": "<string>",
"event_source": "WEB",
"event_data": {
"client_id": "<string>",
"page_location": "<string>",
"session_id": "<string>",
"user_agent": "<string>",
"page_referrer": "<string>"
},
"event_metadata": {
"idempotency_key": "<string>",
"identifiers": {
"user": "<string>",
"organization": "<string>"
},
"consent": {}
}
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
event_name: '<string>',
event_source: 'WEB',
event_data: {
client_id: '<string>',
page_location: '<string>',
session_id: '<string>',
user_agent: '<string>',
page_referrer: '<string>'
},
event_metadata: {
idempotency_key: '<string>',
identifiers: {user: '<string>', organization: '<string>'},
consent: {}
}
}
])
};
fetch('https://api.example.com/v1/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.example.com/v1/events",
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([
[
'event_name' => '<string>',
'event_source' => 'WEB',
'event_data' => [
'client_id' => '<string>',
'page_location' => '<string>',
'session_id' => '<string>',
'user_agent' => '<string>',
'page_referrer' => '<string>'
],
'event_metadata' => [
'idempotency_key' => '<string>',
'identifiers' => [
'user' => '<string>',
'organization' => '<string>'
],
'consent' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.example.com/v1/events"
payload := strings.NewReader("[\n {\n \"event_name\": \"<string>\",\n \"event_source\": \"WEB\",\n \"event_data\": {\n \"client_id\": \"<string>\",\n \"page_location\": \"<string>\",\n \"session_id\": \"<string>\",\n \"user_agent\": \"<string>\",\n \"page_referrer\": \"<string>\"\n },\n \"event_metadata\": {\n \"idempotency_key\": \"<string>\",\n \"identifiers\": {\n \"user\": \"<string>\",\n \"organization\": \"<string>\"\n },\n \"consent\": {}\n }\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.example.com/v1/events")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"event_name\": \"<string>\",\n \"event_source\": \"WEB\",\n \"event_data\": {\n \"client_id\": \"<string>\",\n \"page_location\": \"<string>\",\n \"session_id\": \"<string>\",\n \"user_agent\": \"<string>\",\n \"page_referrer\": \"<string>\"\n },\n \"event_metadata\": {\n \"idempotency_key\": \"<string>\",\n \"identifiers\": {\n \"user\": \"<string>\",\n \"organization\": \"<string>\"\n },\n \"consent\": {}\n }\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"event_name\": \"<string>\",\n \"event_source\": \"WEB\",\n \"event_data\": {\n \"client_id\": \"<string>\",\n \"page_location\": \"<string>\",\n \"session_id\": \"<string>\",\n \"user_agent\": \"<string>\",\n \"page_referrer\": \"<string>\"\n },\n \"event_metadata\": {\n \"idempotency_key\": \"<string>\",\n \"identifiers\": {\n \"user\": \"<string>\",\n \"organization\": \"<string>\"\n },\n \"consent\": {}\n }\n }\n]"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"title": "<string>",
"status": 400,
"detail": "<string>",
"instance": "<string>"
}API Reference
Event Streaming API
Event Streaming API
curl --request POST \
--url https://api.example.com/v1/events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"event_name": "<string>",
"event_source": "WEB",
"event_data": {
"client_id": "<string>",
"page_location": "<string>",
"session_id": "<string>",
"user_agent": "<string>",
"page_referrer": "<string>"
},
"event_metadata": {
"idempotency_key": "<string>",
"identifiers": {
"user": "<string>",
"organization": "<string>"
},
"consent": {}
}
}
]
'import requests
url = "https://api.example.com/v1/events"
payload = [
{
"event_name": "<string>",
"event_source": "WEB",
"event_data": {
"client_id": "<string>",
"page_location": "<string>",
"session_id": "<string>",
"user_agent": "<string>",
"page_referrer": "<string>"
},
"event_metadata": {
"idempotency_key": "<string>",
"identifiers": {
"user": "<string>",
"organization": "<string>"
},
"consent": {}
}
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
event_name: '<string>',
event_source: 'WEB',
event_data: {
client_id: '<string>',
page_location: '<string>',
session_id: '<string>',
user_agent: '<string>',
page_referrer: '<string>'
},
event_metadata: {
idempotency_key: '<string>',
identifiers: {user: '<string>', organization: '<string>'},
consent: {}
}
}
])
};
fetch('https://api.example.com/v1/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.example.com/v1/events",
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([
[
'event_name' => '<string>',
'event_source' => 'WEB',
'event_data' => [
'client_id' => '<string>',
'page_location' => '<string>',
'session_id' => '<string>',
'user_agent' => '<string>',
'page_referrer' => '<string>'
],
'event_metadata' => [
'idempotency_key' => '<string>',
'identifiers' => [
'user' => '<string>',
'organization' => '<string>'
],
'consent' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.example.com/v1/events"
payload := strings.NewReader("[\n {\n \"event_name\": \"<string>\",\n \"event_source\": \"WEB\",\n \"event_data\": {\n \"client_id\": \"<string>\",\n \"page_location\": \"<string>\",\n \"session_id\": \"<string>\",\n \"user_agent\": \"<string>\",\n \"page_referrer\": \"<string>\"\n },\n \"event_metadata\": {\n \"idempotency_key\": \"<string>\",\n \"identifiers\": {\n \"user\": \"<string>\",\n \"organization\": \"<string>\"\n },\n \"consent\": {}\n }\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.example.com/v1/events")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"event_name\": \"<string>\",\n \"event_source\": \"WEB\",\n \"event_data\": {\n \"client_id\": \"<string>\",\n \"page_location\": \"<string>\",\n \"session_id\": \"<string>\",\n \"user_agent\": \"<string>\",\n \"page_referrer\": \"<string>\"\n },\n \"event_metadata\": {\n \"idempotency_key\": \"<string>\",\n \"identifiers\": {\n \"user\": \"<string>\",\n \"organization\": \"<string>\"\n },\n \"consent\": {}\n }\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"event_name\": \"<string>\",\n \"event_source\": \"WEB\",\n \"event_data\": {\n \"client_id\": \"<string>\",\n \"page_location\": \"<string>\",\n \"session_id\": \"<string>\",\n \"user_agent\": \"<string>\",\n \"page_referrer\": \"<string>\"\n },\n \"event_metadata\": {\n \"idempotency_key\": \"<string>\",\n \"identifiers\": {\n \"user\": \"<string>\",\n \"organization\": \"<string>\"\n },\n \"consent\": {}\n }\n }\n]"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"title": "<string>",
"status": 400,
"detail": "<string>",
"instance": "<string>"
}Authorizations
API key from Settings → API Key in your workspace.
Keys are prefixed: ov_live_ for production, ov_test_ for test mode.
Headers
If set, this will override the request schema to the set value
Pattern:
^\d{4}-\d{2}-\d{2}$Body
application/json
Response
Was this page helpful?