Company logoTrust Center Documentation
API v1 Reference/Analytics/Track

Track analytics event

Track a client-side analytics event with custom properties. This endpoint validates the authenticated user context and forwards events to the backend analytics system for processing and aggregation.

Events are processed asynchronously and failures do not affect the client response.

POST
/api/v1/analytics/track
AuthorizationBearer <token>

In: header

eventNamestring

Name of the event to track

Length1 <= length
properties?object

Custom properties associated with the event

Empty Object

Response Body

const body = JSON.stringify({
  "eventName": "account.viewed",
  "properties": {
    "accountId": "account-123",
    "accountName": "Burger King",
    "viewDuration": 45,
    "source": "dashboard"
  }
})

fetch("https://app.orbiqhq.com/api/v1/analytics/track", {
  body
})

{
  "success": true
}

{
  "error": "Invalid event payload: eventName: eventName is required"
}

Empty
Empty
Empty
Empty

How is this guide?