Skip to main content
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": "<unknown>",
    "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>",
    "geoCity": "<string>",
    "geoCountry": "<string>",
    "geoLatitude": 123,
    "geoLongitude": 123,
    "geoRegion": "<string>",
    "ipAddress": "<string>",
    "osName": "<string>",
    "osVersion": "<string>",
    "pagePath": "<string>",
    "pageTitle": "<string>",
    "pageUrl": "<string>",
    "platform": "<string>",
    "receivedTimestamp": "<string>",
    "receivedTimestampNs": "<string>",
    "referrerUrl": "<string>",
    "referringDomain": "<string>",
    "screenName": "<string>",
    "segments": {},
    "sessionId": "<string>",
    "userAgent": "<string>",
    "userId": "<string>",
    "utmCampaign": "<string>",
    "utmContent": "<string>",
    "utmMedium": "<string>",
    "utmSource": "<string>",
    "utmTerm": "<string>"
  }
]
'
null

Authorizations

X-Publishable-Key
string
header
required

Browser-safe publishable key for client-side event collection.

Body

application/json
eventId
string
required
eventName
any
required
eventTimestamp
string
required
organizationId
string
required
anonymousId
string
appVersion
string
beaconRequestId
string
browserName
string
browserVersion
string
consumerId
string
deviceType
string
eventProperties
object
eventSchemaVersion
string
eventTimestampNs
string
geoCity
string
geoCountry
string
geoLatitude
number
geoLongitude
number
geoRegion
string
ipAddress
string
osName
string
osVersion
string
pagePath
string
pageTitle
string
pageUrl
string
platform
string
receivedTimestamp
string
receivedTimestampNs
string
referrerUrl
string
referringDomain
string
screenName
string
segments
object
sessionId
string
userAgent
string
userId
string
utmCampaign
string
utmContent
string
utmMedium
string
utmSource
string
utmTerm
string

Response

Event accepted for processing.