Statistics & analytics
Get tracking sessions by attendee id
7min
Get all tracking sessions for a specific attendee at the event
GET
Params
Path Params
{organizationId}
required
Number
The id of the Brella organization you are trying to retrieve data from
{eventId}
required
Number
The id of the Brella event you are trying to retrieve data from
{attendeeId}
required
Number
The id of the attendee you are trying to retrieve data from
Header Parameters
Brella-API-Access-Token
required
String
Your unique Brella API key
Accept
required
String
application/vnd.brella.v4+json
Content-Type
required
String
application/json
- This endpoint can be filtered by trackable_type which accepts the following value, in order to return only the tracking_sessions and slices related to watching streams:
- StreamLink
- This endpoint doesn't discriminate by event start date / time, but tracks every session from the time an attendee first joins the platform.
- Filtering may be added in the future.
- For now, the next tracking_slices endpoint has extensive filtering by date/ time and interaction type.
This endpoint exposes four types of tracking data for the selected attendee:
- Time-spent in the web and native (iOS / Android) apps, divided into "sessions". A session can end when a tab is closed, the app is put to sleep in the background, or when a network connection is disrupted/ lost.
- Time spent watching video streams in the event
- Clicks on a sponsor booth
- Time spent interacting with media in sponsor booths (only tracked if the sponsor has added at least one type of rich media in their sponsor booth).
Sessions:
- The TrackingSession itself has a duration, and consists of multiple tracking slices. If you want to know the times an attendee was on the platform, you need to look at the tracking_session_slices (in the Included section of this endpoint’s response; or you can query these tracking slices directly using the next endpoint — /tracking_session_slices —listed in this document, which also includes a variety of filtering options)
{
"id": "2910650",
"type": "tracking-session",
"attributes": {
"interaction-count": 0,
"duration-seconds": 4521
},
"relationships": {
"trackable": {
"data": {
"id": "6947",
"type": "trackable"
}
},
"tracking-session-slices": {
"data": [
{
"id": "15775729",
"type": "tracking-session-slice"
},
{
"id": "15776074",
"type": "tracking-session-slice"
},
{
"id": "15776752",
"type": "tracking-session-slice"
},
{
"id": "15866946",
"type": "tracking-session-slice"
},
{
"id": "15867812",
"type": "tracking-session-slice"
}
]
}
}
}
Video stream viewed:
{
"id": "10447",
"type": "trackable",
"attributes": {
"trackable-type": "StreamLink",
"name": null,
"title": "Example Live Stream: Session X on Y",
"url": "https://vimeo.com/event/123456/embed",
"body-type": "stream-links"
}
}
A booth visit:
{
{
"id": "63293",
"type": "trackable",
"attributes": {
"trackable-type": "Sponsor",
"name": "Google Cloud Platform",
"title": null,
"url": null,
"body-type": null
}
},
{
"id": "13321762",
"type": "tracking-session-slice",
"attributes": {
"tracking-type": "click",
"click-time": "2022-05-03T03:51:21.841Z",
"start-time": null,
"end-time": null,
"duration-seconds": 0
}
}
A click on a media item within a sponsor booth:
{
"id": "15386392",
"type": "tracking-session-slice",
"attributes": {
"tracking-type": "click",
"click-time": "2023-06-01T18:32:07.291Z",
"start-time": null,
"end-time": null,
"duration-seconds": 0
}
}
This endpoint cannot distinguish between time spent on various app types (web, iOS, Android). This is a feature that is being researched. No roadmap commitments currently exist at the time of writing.
Updated 15 Nov 2023
Did this page help you?