Events
POST /events/batch
Receive a batch of beacon tracking events
POST
/
events
/
batch
cURL
curl --request POST \
--url https://beacon.fanfare.io/api/events/batch \
--header 'Content-Type: application/json' \
--header 'X-Publishable-Key: <api-key>' \
--data '
[
{
"eventId": "<string>",
"eventName": "pageView",
"eventTimestamp": "<string>",
"organizationId": "<string>",
"anonymousId": "<string>",
"appVersion": "<string>",
"beaconRequestId": "<string>",
"browserName": "<string>",
"browserVersion": "<string>",
"consumerId": "<string>",
"deviceType": "<string>",
"eventProperties": {
"geoLat": 123,
"geoLng": 123,
"pageType": "<string>",
"postalCode": "<string>",
"timezone": "<string>"
},
"eventSchemaVersion": "<string>",
"eventTimestampNs": "<string>",
"experienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"geoCity": "<string>",
"geoCountry": "<string>",
"geoLatitude": 123,
"geoLongitude": 123,
"geoRegion": "<string>",
"ipAddress": "<string>",
"isGuest": true,
"osName": "<string>",
"osVersion": "<string>",
"pagePath": "<string>",
"pageTitle": "<string>",
"pageUrl": "<string>",
"platform": "<string>",
"receivedTimestamp": "<string>",
"receivedTimestampNs": "<string>",
"referrerUrl": "<string>",
"referringDomain": "<string>",
"screenName": "<string>",
"segments": {},
"sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sessionId": "<string>",
"userAgent": "<string>",
"userId": "<string>",
"utmCampaign": "<string>",
"utmContent": "<string>",
"utmMedium": "<string>",
"utmSource": "<string>",
"utmTerm": "<string>"
}
]
'const options = {
method: 'POST',
headers: {'X-Publishable-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
eventId: '<string>',
eventName: 'pageView',
eventTimestamp: '<string>',
organizationId: '<string>',
anonymousId: '<string>',
appVersion: '<string>',
beaconRequestId: '<string>',
browserName: '<string>',
browserVersion: '<string>',
consumerId: '<string>',
deviceType: '<string>',
eventProperties: {
geoLat: 123,
geoLng: 123,
pageType: '<string>',
postalCode: '<string>',
timezone: '<string>'
},
eventSchemaVersion: '<string>',
eventTimestampNs: '<string>',
experienceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
geoCity: '<string>',
geoCountry: '<string>',
geoLatitude: 123,
geoLongitude: 123,
geoRegion: '<string>',
ipAddress: '<string>',
isGuest: true,
osName: '<string>',
osVersion: '<string>',
pagePath: '<string>',
pageTitle: '<string>',
pageUrl: '<string>',
platform: '<string>',
receivedTimestamp: '<string>',
receivedTimestampNs: '<string>',
referrerUrl: '<string>',
referringDomain: '<string>',
screenName: '<string>',
segments: {},
sequenceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sessionId: '<string>',
userAgent: '<string>',
userId: '<string>',
utmCampaign: '<string>',
utmContent: '<string>',
utmMedium: '<string>',
utmSource: '<string>',
utmTerm: '<string>'
}
])
};
fetch('https://beacon.fanfare.io/api/events/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://beacon.fanfare.io/api/events/batch"
payload = [
{
"eventId": "<string>",
"eventName": "pageView",
"eventTimestamp": "<string>",
"organizationId": "<string>",
"anonymousId": "<string>",
"appVersion": "<string>",
"beaconRequestId": "<string>",
"browserName": "<string>",
"browserVersion": "<string>",
"consumerId": "<string>",
"deviceType": "<string>",
"eventProperties": {
"geoLat": 123,
"geoLng": 123,
"pageType": "<string>",
"postalCode": "<string>",
"timezone": "<string>"
},
"eventSchemaVersion": "<string>",
"eventTimestampNs": "<string>",
"experienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"geoCity": "<string>",
"geoCountry": "<string>",
"geoLatitude": 123,
"geoLongitude": 123,
"geoRegion": "<string>",
"ipAddress": "<string>",
"isGuest": True,
"osName": "<string>",
"osVersion": "<string>",
"pagePath": "<string>",
"pageTitle": "<string>",
"pageUrl": "<string>",
"platform": "<string>",
"receivedTimestamp": "<string>",
"receivedTimestampNs": "<string>",
"referrerUrl": "<string>",
"referringDomain": "<string>",
"screenName": "<string>",
"segments": {},
"sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sessionId": "<string>",
"userAgent": "<string>",
"userId": "<string>",
"utmCampaign": "<string>",
"utmContent": "<string>",
"utmMedium": "<string>",
"utmSource": "<string>",
"utmTerm": "<string>"
}
]
headers = {
"X-Publishable-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://beacon.fanfare.io/api/events/batch"
payload := strings.NewReader("[\n {\n \"eventId\": \"<string>\",\n \"eventName\": \"pageView\",\n \"eventTimestamp\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"anonymousId\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"beaconRequestId\": \"<string>\",\n \"browserName\": \"<string>\",\n \"browserVersion\": \"<string>\",\n \"consumerId\": \"<string>\",\n \"deviceType\": \"<string>\",\n \"eventProperties\": {\n \"geoLat\": 123,\n \"geoLng\": 123,\n \"pageType\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"timezone\": \"<string>\"\n },\n \"eventSchemaVersion\": \"<string>\",\n \"eventTimestampNs\": \"<string>\",\n \"experienceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"geoCity\": \"<string>\",\n \"geoCountry\": \"<string>\",\n \"geoLatitude\": 123,\n \"geoLongitude\": 123,\n \"geoRegion\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"isGuest\": true,\n \"osName\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"pagePath\": \"<string>\",\n \"pageTitle\": \"<string>\",\n \"pageUrl\": \"<string>\",\n \"platform\": \"<string>\",\n \"receivedTimestamp\": \"<string>\",\n \"receivedTimestampNs\": \"<string>\",\n \"referrerUrl\": \"<string>\",\n \"referringDomain\": \"<string>\",\n \"screenName\": \"<string>\",\n \"segments\": {},\n \"sequenceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sessionId\": \"<string>\",\n \"userAgent\": \"<string>\",\n \"userId\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmContent\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmSource\": \"<string>\",\n \"utmTerm\": \"<string>\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Publishable-Key", "<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))
}null{
"error": "validation_error",
"issues": [
{
"expected": "<string>",
"kind": "<string>",
"message": "<string>",
"path": [
{
"input": "<unknown>",
"key": "<string>",
"origin": "<string>",
"type": "<string>"
}
],
"received": "<string>",
"type": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Browser-safe publishable key for client-side event collection.
Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Event accepted for processing.
⌘I
cURL
curl --request POST \
--url https://beacon.fanfare.io/api/events/batch \
--header 'Content-Type: application/json' \
--header 'X-Publishable-Key: <api-key>' \
--data '
[
{
"eventId": "<string>",
"eventName": "pageView",
"eventTimestamp": "<string>",
"organizationId": "<string>",
"anonymousId": "<string>",
"appVersion": "<string>",
"beaconRequestId": "<string>",
"browserName": "<string>",
"browserVersion": "<string>",
"consumerId": "<string>",
"deviceType": "<string>",
"eventProperties": {
"geoLat": 123,
"geoLng": 123,
"pageType": "<string>",
"postalCode": "<string>",
"timezone": "<string>"
},
"eventSchemaVersion": "<string>",
"eventTimestampNs": "<string>",
"experienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"geoCity": "<string>",
"geoCountry": "<string>",
"geoLatitude": 123,
"geoLongitude": 123,
"geoRegion": "<string>",
"ipAddress": "<string>",
"isGuest": true,
"osName": "<string>",
"osVersion": "<string>",
"pagePath": "<string>",
"pageTitle": "<string>",
"pageUrl": "<string>",
"platform": "<string>",
"receivedTimestamp": "<string>",
"receivedTimestampNs": "<string>",
"referrerUrl": "<string>",
"referringDomain": "<string>",
"screenName": "<string>",
"segments": {},
"sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sessionId": "<string>",
"userAgent": "<string>",
"userId": "<string>",
"utmCampaign": "<string>",
"utmContent": "<string>",
"utmMedium": "<string>",
"utmSource": "<string>",
"utmTerm": "<string>"
}
]
'const options = {
method: 'POST',
headers: {'X-Publishable-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
eventId: '<string>',
eventName: 'pageView',
eventTimestamp: '<string>',
organizationId: '<string>',
anonymousId: '<string>',
appVersion: '<string>',
beaconRequestId: '<string>',
browserName: '<string>',
browserVersion: '<string>',
consumerId: '<string>',
deviceType: '<string>',
eventProperties: {
geoLat: 123,
geoLng: 123,
pageType: '<string>',
postalCode: '<string>',
timezone: '<string>'
},
eventSchemaVersion: '<string>',
eventTimestampNs: '<string>',
experienceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
geoCity: '<string>',
geoCountry: '<string>',
geoLatitude: 123,
geoLongitude: 123,
geoRegion: '<string>',
ipAddress: '<string>',
isGuest: true,
osName: '<string>',
osVersion: '<string>',
pagePath: '<string>',
pageTitle: '<string>',
pageUrl: '<string>',
platform: '<string>',
receivedTimestamp: '<string>',
receivedTimestampNs: '<string>',
referrerUrl: '<string>',
referringDomain: '<string>',
screenName: '<string>',
segments: {},
sequenceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sessionId: '<string>',
userAgent: '<string>',
userId: '<string>',
utmCampaign: '<string>',
utmContent: '<string>',
utmMedium: '<string>',
utmSource: '<string>',
utmTerm: '<string>'
}
])
};
fetch('https://beacon.fanfare.io/api/events/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://beacon.fanfare.io/api/events/batch"
payload = [
{
"eventId": "<string>",
"eventName": "pageView",
"eventTimestamp": "<string>",
"organizationId": "<string>",
"anonymousId": "<string>",
"appVersion": "<string>",
"beaconRequestId": "<string>",
"browserName": "<string>",
"browserVersion": "<string>",
"consumerId": "<string>",
"deviceType": "<string>",
"eventProperties": {
"geoLat": 123,
"geoLng": 123,
"pageType": "<string>",
"postalCode": "<string>",
"timezone": "<string>"
},
"eventSchemaVersion": "<string>",
"eventTimestampNs": "<string>",
"experienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"geoCity": "<string>",
"geoCountry": "<string>",
"geoLatitude": 123,
"geoLongitude": 123,
"geoRegion": "<string>",
"ipAddress": "<string>",
"isGuest": True,
"osName": "<string>",
"osVersion": "<string>",
"pagePath": "<string>",
"pageTitle": "<string>",
"pageUrl": "<string>",
"platform": "<string>",
"receivedTimestamp": "<string>",
"receivedTimestampNs": "<string>",
"referrerUrl": "<string>",
"referringDomain": "<string>",
"screenName": "<string>",
"segments": {},
"sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sessionId": "<string>",
"userAgent": "<string>",
"userId": "<string>",
"utmCampaign": "<string>",
"utmContent": "<string>",
"utmMedium": "<string>",
"utmSource": "<string>",
"utmTerm": "<string>"
}
]
headers = {
"X-Publishable-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://beacon.fanfare.io/api/events/batch"
payload := strings.NewReader("[\n {\n \"eventId\": \"<string>\",\n \"eventName\": \"pageView\",\n \"eventTimestamp\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"anonymousId\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"beaconRequestId\": \"<string>\",\n \"browserName\": \"<string>\",\n \"browserVersion\": \"<string>\",\n \"consumerId\": \"<string>\",\n \"deviceType\": \"<string>\",\n \"eventProperties\": {\n \"geoLat\": 123,\n \"geoLng\": 123,\n \"pageType\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"timezone\": \"<string>\"\n },\n \"eventSchemaVersion\": \"<string>\",\n \"eventTimestampNs\": \"<string>\",\n \"experienceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"geoCity\": \"<string>\",\n \"geoCountry\": \"<string>\",\n \"geoLatitude\": 123,\n \"geoLongitude\": 123,\n \"geoRegion\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"isGuest\": true,\n \"osName\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"pagePath\": \"<string>\",\n \"pageTitle\": \"<string>\",\n \"pageUrl\": \"<string>\",\n \"platform\": \"<string>\",\n \"receivedTimestamp\": \"<string>\",\n \"receivedTimestampNs\": \"<string>\",\n \"referrerUrl\": \"<string>\",\n \"referringDomain\": \"<string>\",\n \"screenName\": \"<string>\",\n \"segments\": {},\n \"sequenceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sessionId\": \"<string>\",\n \"userAgent\": \"<string>\",\n \"userId\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmContent\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmSource\": \"<string>\",\n \"utmTerm\": \"<string>\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Publishable-Key", "<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))
}null{
"error": "validation_error",
"issues": [
{
"expected": "<string>",
"kind": "<string>",
"message": "<string>",
"path": [
{
"input": "<unknown>",
"key": "<string>",
"origin": "<string>",
"type": "<string>"
}
],
"received": "<string>",
"type": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}