Statistics & analytics
Get tracking session slices by attendee id
4min
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
Notes:
The following url attributes are accepted for filtering:
- tracking_type
- trackable_type
- click_time
- start_time
- end_time
- duration
- start_from
- start_to
- end_from
- end_to
Note on filtering by tracking_type:
By default, this endpoint returns three types of tracking sessions:
- time_spent
- sponsor
- streamlink
Give the value for this param as "time_spent" — otherwise, it will also return clicks in media elements in the sponsor booth etc.
A note about filtering by time (i.e. using start_time, end_time, start_from, start_to, end_from, end_to)
- start_time and end_time will search for an exact match for sessions that start / end at an exact time. These filtering options are not commonly used in automated retrievals, unless you are manually searching for slices from an exact time.
- For automated retrieval, we recommend using the start_from, start_to, end_from, end_to attributes.
- By providing these attributes, the endpoint finds records where start_time is between start_from and start_to. Respectively it finds records where end_time is between end_from and end_to.
- You can also provide an open-ended time range, for example by only providing start_from but not start_to. In this case the endpoint selects records where start_time is greater than or equal to start_from but doesn't limit results by a maximum start_time.
Whether an attendee "checks-in to" / uses the event app during the event
An example use-case of tracking whether an attendee “checked-in” to Brella during an event (presence):
- Let's assume that you have an event that begins on 2023-05-10 and ends on 2023-05-15. You've invited people to Brella a week before the event, BUT, you are only interested in whether they checked-in after the event begins (i.e. on or after 2023-05-10).
- So, your requests would look like the following:
- https://api.brella.io/api/integration/organizations/{{organizationId}}/events/{{event_id}}/attendees/{{attendeeId}}/tracking_session_slices?tracking_type=time_spent&start_from=2023-05-10T00:00:00.000Z
- This would return any session slices that begin after 2023-05-10T00:00:00.000Z. While you could specify the exact event start time as well, we recommend just leaving it at midnight that day to account for edge cases.
- IF the attendee has visited Brella after the specified time, the endpoint will return all relevant tracking session slices. IF the attendee didn't "check-in/ visit Brella during this time", it will return an empty response.
- So, basically, all you need to do is run this query for your attendees, dynamically replacing the attendee_id, and if the response is empty: They haven't "checked-in", if the response has data, then, that attendee has "checked in".
Updated 16 Nov 2023
Did this page help you?