curl --request POST \
--url http://localhost:3001/api/public/apps/page \
--header 'Content-Type: application/json' \
--header 'PublicWriteKey: <api-key>' \
--header 'authorization: <authorization>' \
--data '
{
"messageId": "23d04926-78e5-4ebc-853f-f26c84ff629e",
"userId": "1043",
"timestamp": "2024-04-22T07:00:00.000Z",
"context": {
"ip": "192.0.2.1"
},
"name": "Home",
"properties": {
"title": "My Site",
"url": "http://www.site.com"
}
}
'import requests
url = "http://localhost:3001/api/public/apps/page"
payload = {
"messageId": "23d04926-78e5-4ebc-853f-f26c84ff629e",
"userId": "1043",
"timestamp": "2024-04-22T07:00:00.000Z",
"context": { "ip": "192.0.2.1" },
"name": "Home",
"properties": {
"title": "My Site",
"url": "http://www.site.com"
}
}
headers = {
"authorization": "<authorization>",
"PublicWriteKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
authorization: '<authorization>',
PublicWriteKey: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
messageId: '23d04926-78e5-4ebc-853f-f26c84ff629e',
userId: '1043',
timestamp: '2024-04-22T07:00:00.000Z',
context: {ip: '192.0.2.1'},
name: 'Home',
properties: {title: 'My Site', url: 'http://www.site.com'}
})
};
fetch('http://localhost:3001/api/public/apps/page', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/public/apps/page",
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([
'messageId' => '23d04926-78e5-4ebc-853f-f26c84ff629e',
'userId' => '1043',
'timestamp' => '2024-04-22T07:00:00.000Z',
'context' => [
'ip' => '192.0.2.1'
],
'name' => 'Home',
'properties' => [
'title' => 'My Site',
'url' => 'http://www.site.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"PublicWriteKey: <api-key>",
"authorization: <authorization>"
],
]);
$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 := "http://localhost:3001/api/public/apps/page"
payload := strings.NewReader("{\n \"messageId\": \"23d04926-78e5-4ebc-853f-f26c84ff629e\",\n \"userId\": \"1043\",\n \"timestamp\": \"2024-04-22T07:00:00.000Z\",\n \"context\": {\n \"ip\": \"192.0.2.1\"\n },\n \"name\": \"Home\",\n \"properties\": {\n \"title\": \"My Site\",\n \"url\": \"http://www.site.com\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<authorization>")
req.Header.Add("PublicWriteKey", "<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("http://localhost:3001/api/public/apps/page")
.header("authorization", "<authorization>")
.header("PublicWriteKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messageId\": \"23d04926-78e5-4ebc-853f-f26c84ff629e\",\n \"userId\": \"1043\",\n \"timestamp\": \"2024-04-22T07:00:00.000Z\",\n \"context\": {\n \"ip\": \"192.0.2.1\"\n },\n \"name\": \"Home\",\n \"properties\": {\n \"title\": \"My Site\",\n \"url\": \"http://www.site.com\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/public/apps/page")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["PublicWriteKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messageId\": \"23d04926-78e5-4ebc-853f-f26c84ff629e\",\n \"userId\": \"1043\",\n \"timestamp\": \"2024-04-22T07:00:00.000Z\",\n \"context\": {\n \"ip\": \"192.0.2.1\"\n },\n \"name\": \"Home\",\n \"properties\": {\n \"title\": \"My Site\",\n \"url\": \"http://www.site.com\"\n }\n}"
response = http.request(request)
puts response.read_body"<string>"{
"message": "<string>"
}POST /api/public/apps/page
The page call lets you record whenever a user sees a page of your website, along with any optional properties about the page.
curl --request POST \
--url http://localhost:3001/api/public/apps/page \
--header 'Content-Type: application/json' \
--header 'PublicWriteKey: <api-key>' \
--header 'authorization: <authorization>' \
--data '
{
"messageId": "23d04926-78e5-4ebc-853f-f26c84ff629e",
"userId": "1043",
"timestamp": "2024-04-22T07:00:00.000Z",
"context": {
"ip": "192.0.2.1"
},
"name": "Home",
"properties": {
"title": "My Site",
"url": "http://www.site.com"
}
}
'import requests
url = "http://localhost:3001/api/public/apps/page"
payload = {
"messageId": "23d04926-78e5-4ebc-853f-f26c84ff629e",
"userId": "1043",
"timestamp": "2024-04-22T07:00:00.000Z",
"context": { "ip": "192.0.2.1" },
"name": "Home",
"properties": {
"title": "My Site",
"url": "http://www.site.com"
}
}
headers = {
"authorization": "<authorization>",
"PublicWriteKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
authorization: '<authorization>',
PublicWriteKey: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
messageId: '23d04926-78e5-4ebc-853f-f26c84ff629e',
userId: '1043',
timestamp: '2024-04-22T07:00:00.000Z',
context: {ip: '192.0.2.1'},
name: 'Home',
properties: {title: 'My Site', url: 'http://www.site.com'}
})
};
fetch('http://localhost:3001/api/public/apps/page', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/public/apps/page",
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([
'messageId' => '23d04926-78e5-4ebc-853f-f26c84ff629e',
'userId' => '1043',
'timestamp' => '2024-04-22T07:00:00.000Z',
'context' => [
'ip' => '192.0.2.1'
],
'name' => 'Home',
'properties' => [
'title' => 'My Site',
'url' => 'http://www.site.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"PublicWriteKey: <api-key>",
"authorization: <authorization>"
],
]);
$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 := "http://localhost:3001/api/public/apps/page"
payload := strings.NewReader("{\n \"messageId\": \"23d04926-78e5-4ebc-853f-f26c84ff629e\",\n \"userId\": \"1043\",\n \"timestamp\": \"2024-04-22T07:00:00.000Z\",\n \"context\": {\n \"ip\": \"192.0.2.1\"\n },\n \"name\": \"Home\",\n \"properties\": {\n \"title\": \"My Site\",\n \"url\": \"http://www.site.com\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<authorization>")
req.Header.Add("PublicWriteKey", "<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("http://localhost:3001/api/public/apps/page")
.header("authorization", "<authorization>")
.header("PublicWriteKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messageId\": \"23d04926-78e5-4ebc-853f-f26c84ff629e\",\n \"userId\": \"1043\",\n \"timestamp\": \"2024-04-22T07:00:00.000Z\",\n \"context\": {\n \"ip\": \"192.0.2.1\"\n },\n \"name\": \"Home\",\n \"properties\": {\n \"title\": \"My Site\",\n \"url\": \"http://www.site.com\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/public/apps/page")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["PublicWriteKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messageId\": \"23d04926-78e5-4ebc-853f-f26c84ff629e\",\n \"userId\": \"1043\",\n \"timestamp\": \"2024-04-22T07:00:00.000Z\",\n \"context\": {\n \"ip\": \"192.0.2.1\"\n },\n \"name\": \"Home\",\n \"properties\": {\n \"title\": \"My Site\",\n \"url\": \"http://www.site.com\"\n }\n}"
response = http.request(request)
puts response.read_body"<string>"{
"message": "<string>"
}{
"name": "Overview",
"userId": "1043",
"properties": {
"url": "/dashboard/overview"
},
"messageId": "1ff51c9c-4929-45de-8914-3bb878be8c4a"
}
Authorizations
Authorization header for the request, in the format Bearer <token>. You can collect your token at https://app.tranthor.com/dashboard/settings#write-key.
Headers
Authorization header for the request, in the format Bearer <token>. You can collect your token at https://app.tranthor.com/dashboard/settings#write-key.
Body
- Option 1
- Option 2
Unique identifier for the message, used as an idempotency key for safe retries. Can provide a UUID.
"23d04926-78e5-4ebc-853f-f26c84ff629e"
Unique identifier for the user. Should be the id of the user in your system. Only applicable to logged in users.
"1043"
"user-123"
"0a58e5e4-c753-477e-a6c4-f9b0e3396b9b"
ISO 8601 formatted timestamp of when the event occurred. If not provided, the current server time will be used.
"2024-04-22T07:00:00.000Z"
Provides metadata about the user submitting the event and the context in which the event occurred.
Show child attributes
Show child attributes
{ "ip": "192.0.2.1" }
Name of the page visited by the user.
"Home"
Free-form dictionary of properties of the page, like url and referrer. Can contain arbitrary JSON values.
Show child attributes
Show child attributes
{ "title": "My Site", "url": "http://www.site.com" }
Response
An empty String
An empty String

