Track engagement events (public, publishable tracking key)
curl --request POST \
--url 'https://api.example.com/v1/track?key=' \
--header 'Content-Type: application/json' \
--data '
{
"events": [
{
"tags": [
"<string>"
],
"member_external_id": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "<string>",
"event_id": "<string>",
"occurred_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"key": "<string>"
}
'import requests
url = "https://api.example.com/v1/track?key="
payload = {
"events": [
{
"tags": ["<string>"],
"member_external_id": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "<string>",
"event_id": "<string>",
"occurred_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"key": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
events: [
{
tags: ['<string>'],
member_external_id: '<string>',
user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
action: '<string>',
event_id: '<string>',
occurred_at: '2023-11-07T05:31:56Z',
metadata: {}
}
],
key: '<string>'
})
};
fetch('https://api.example.com/v1/track?key=', 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/track?key=",
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([
'events' => [
[
'tags' => [
'<string>'
],
'member_external_id' => '<string>',
'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'action' => '<string>',
'event_id' => '<string>',
'occurred_at' => '2023-11-07T05:31:56Z',
'metadata' => [
]
]
],
'key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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/track?key="
payload := strings.NewReader("{\n \"events\": [\n {\n \"tags\": [\n \"<string>\"\n ],\n \"member_external_id\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"action\": \"<string>\",\n \"event_id\": \"<string>\",\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n }\n ],\n \"key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/track?key=")
.header("Content-Type", "application/json")
.body("{\n \"events\": [\n {\n \"tags\": [\n \"<string>\"\n ],\n \"member_external_id\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"action\": \"<string>\",\n \"event_id\": \"<string>\",\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n }\n ],\n \"key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/track?key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [\n {\n \"tags\": [\n \"<string>\"\n ],\n \"member_external_id\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"action\": \"<string>\",\n \"event_id\": \"<string>\",\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n }\n ],\n \"key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "<string>",
"event_id": "<string>",
"reason": "<string>"
}
]
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}Engagement
Track engagement events (public, publishable tracking key)
Public CORS-enabled receptor for browser engagement events. Authenticates with a publishable ek_live_… tracking key sent as ?key= or the body key field - partner bearer keys are not accepted here. Accepts a batch (events: [...], max 20) or a single event spread at the top level. Events are accepted per-item: the 202 envelope reports accepted/duplicate/rejected per event.
POST
/
v1
/
track
Track engagement events (public, publishable tracking key)
curl --request POST \
--url 'https://api.example.com/v1/track?key=' \
--header 'Content-Type: application/json' \
--data '
{
"events": [
{
"tags": [
"<string>"
],
"member_external_id": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "<string>",
"event_id": "<string>",
"occurred_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"key": "<string>"
}
'import requests
url = "https://api.example.com/v1/track?key="
payload = {
"events": [
{
"tags": ["<string>"],
"member_external_id": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "<string>",
"event_id": "<string>",
"occurred_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"key": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
events: [
{
tags: ['<string>'],
member_external_id: '<string>',
user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
action: '<string>',
event_id: '<string>',
occurred_at: '2023-11-07T05:31:56Z',
metadata: {}
}
],
key: '<string>'
})
};
fetch('https://api.example.com/v1/track?key=', 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/track?key=",
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([
'events' => [
[
'tags' => [
'<string>'
],
'member_external_id' => '<string>',
'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'action' => '<string>',
'event_id' => '<string>',
'occurred_at' => '2023-11-07T05:31:56Z',
'metadata' => [
]
]
],
'key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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/track?key="
payload := strings.NewReader("{\n \"events\": [\n {\n \"tags\": [\n \"<string>\"\n ],\n \"member_external_id\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"action\": \"<string>\",\n \"event_id\": \"<string>\",\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n }\n ],\n \"key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/track?key=")
.header("Content-Type", "application/json")
.body("{\n \"events\": [\n {\n \"tags\": [\n \"<string>\"\n ],\n \"member_external_id\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"action\": \"<string>\",\n \"event_id\": \"<string>\",\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n }\n ],\n \"key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/track?key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [\n {\n \"tags\": [\n \"<string>\"\n ],\n \"member_external_id\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"action\": \"<string>\",\n \"event_id\": \"<string>\",\n \"occurred_at\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n }\n ],\n \"key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "<string>",
"event_id": "<string>",
"reason": "<string>"
}
]
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}Authorizations
Publishable engagement tracking key (ek_live_…), sent as ?key= or the body key field. Safe to embed in client code - abuse is bounded by the per-key origin allowlist and rate limit.
Query Parameters
Publishable tracking key (alternative to the body key field)
Body
application/json
Response
Per-event outcomes
Show child attributes
Show child attributes
Download the invalid+failed rows as CSV (also the console's download URL, cookie auth)List the organization's tracking keys
⌘I