Analytics Events

Pro & EnterpriseAnalytics requires a Pro or Enterprise subscription.

Compare plans

Detailed reference for all trackable events and their parameters.

Event Types

Area Events

Frontend Event	Backend Mapping	Allowed Parameters
areaClick	area.click	id, name, floor
areaHover	area.hover	id, name, floor
areaFocus	area.select	id, name, floor
areaBookmark	area.select	id, name, floor

Marker Events

Frontend Event	Backend Mapping	Allowed Parameters
markerClick	marker.click	id, name, floor
markerHover	marker.hover	id, name, floor
markerInfoOpen	marker.select	id, name, floor

Floor Events

Frontend Event	Backend Mapping	Allowed Parameters
floorChange	floor.switch	id, name, floor
floorZoomFocus	floor.select	id, name, floor
floorLoad	floor.select	id, name, floor

Search Events

Frontend Event	Backend Mapping	Allowed Parameters
searchQuery	search.query	query
searchResultClick	search.select	query, id, name
searchNoResults	search.query	query

Wayfinding Events

Frontend Event	Backend Mapping	Allowed Parameters
routeRequest	wayfinding.route	id, name, floor, originId, originName, originLevelId, destinationId, destinationName, destinationLevelId

Other Events

Frontend Event	Backend Mapping	Allowed Parameters
zoomChange	zoom.change	(none)
panMove	zoom.change	(none)
componentLoaded	general.componentLoaded	(none)
componentUnmounted	general.componentUnmounted	(none)
interactionTime	general.interactionTime	durationMs

Submitting Events

Events are submitted via the public API:

POST /api/p/{project_id}/analytics/
Content-Type: application/json

{
  "events": [
    {
      "event": "areaClick",
      "params": {
        "id": "area-uuid",
        "name": "Coffee Shop",
        "floor": "floor-1"
      },
      "timestamp": "2024-04-12T14:30:00Z"
    }
  ]
}

Parameter Validation

• Only whitelisted parameters for each event type are accepted (see tables above)
• String values are truncated to 500 characters
• Only string, integer, and float values are allowed
• Unknown event types are silently ignored

SDK Events vs Analytics Events

Analytics events are tracked automatically by the embedded map. They are separate from SDK events (areaClick, markerClick, etc.) which are dispatched to your application code.