Statistics & analytics
Get tracking sessions by attendee id
7 min
{ "tab" "examples", "url" "https //api brella io/api/integration/organizations/{organizationid}/events/{eventid}/attendees/{attendeeid}/tracking sessions", "name" "get tracking sessions by attendee id", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "{organizationid}", "type" "number", "children" \[], "description" "the id of the brella organization you are trying to retrieve data from" }, { "kind" "required", "name" "{eventid}", "type" "number", "children" \[], "description" "the id of the brella event you are trying to retrieve data from" }, { "kind" "required", "name" "{attendeeid}", "type" "number", "children" \[], "description" "the id of the attendee you are trying to retrieve data from" } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "brella api access token", "type" "string", "children" \[], "description" "your unique brella api key" }, { "kind" "required", "name" "accept", "type" "string", "children" \[], "description" "application/vnd brella v4+json" }, { "kind" "required", "name" "content type", "type" "string", "children" \[], "description" "application/json" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "psobomoj9uo00ibrqhmgp", "code" "\\"data\\" \[\n {\n \\"id\\" \\"2871462\\",\n \\"type\\" \\"tracking session\\",\n \\"attributes\\" {\n \\"interaction count\\" 0,\n \\"duration seconds\\" 3329\n },\n \\"relationships\\" {\n \\"trackable\\" {\n \\"data\\" {\n \\"id\\" \\"6946\\",\n \\"type\\" \\"trackable\\"\n }\n },\n \\"tracking session slices\\" {\n \\"data\\" \[\n {\n \\"id\\" \\"15299989\\",\n \\"type\\" \\"tracking session slice\\"\n },\n {\n \\"id\\" \\"15368214\\",\n \\"type\\" \\"tracking session slice\\"\n },\n {\n \\"id\\" \\"15376377\\",\n \\"type\\" \\"tracking session slice\\"\n }\n ]\n }\n }\n }\n ],\n \\"included\\" \[\n {\n \\"id\\" \\"1234\\",\n \\"type\\" \\"trackable\\",\n \\"attributes\\" {\n \\"trackable type\\" \\"event\\",\n \\"name\\" \\"space conference \\",\n \\"title\\" null,\n \\"url\\" null,\n \\"body type\\" null\n }\n },\n {\n \\"id\\" \\"15247989\\",\n \\"type\\" \\"tracking session slice\\",\n \\"attributes\\" {\n \\"tracking type\\" \\"time spent\\",\n \\"click time\\" null,\n \\"start time\\" \\"2023 05 29t13 08 37 683z\\",\n \\"end time\\" \\"2023 05 29t13 37 34 742z\\",\n \\"duration seconds\\" 1737\n }\n },\n {\n \\"id\\" \\"15368214\\",\n \\"type\\" \\"tracking session slice\\",\n \\"attributes\\" {\n \\"tracking type\\" \\"time spent\\",\n \\"click time\\" null,\n \\"start time\\" \\"2023 06 01t07 53 07 707z\\",\n \\"end time\\" \\"2023 06 01t07 58 10 964z\\",\n \\"duration seconds\\" 303\n }\n },\n {\n \\"id\\" \\"15376377\\",\n \\"type\\" \\"tracking session slice\\",\n \\"attributes\\" {\n \\"tracking type\\" \\"time spent\\",\n \\"click time\\" null,\n \\"start time\\" \\"2023 06 01t12 56 05 973z\\",\n \\"end time\\" \\"2023 06 01t13 17 35 087z\\",\n \\"duration seconds\\" 1289\n }\n }\n ],\n \\"meta\\" {\n \\"total count\\" 1,\n \\"total pages\\" 1,\n \\"current page\\" 1\n }\n}\n", "language" "200", "customlabel" "" } ], "selectedlanguageid" "psobomoj9uo00ibrqhmgp" }, "examples" { "languages" \[ { "id" "58 p6ec5ew 4ak8jmjcmg", "code" "curl location g request get 'https //api brella io/api/integration/organizations/{organizationid}/events/{eventid}/attendees/{attendeeid}/tracking sessions' \\\\\n header 'brella api access token string' \\\\\n header 'accept application/vnd brella v4+json' \\\\\n header 'content type application/json'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "58 p6ec5ew 4ak8jmjcmg" }, "description" "get all tracking sessions for a specific attendee at the event", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } notes filtering 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 available data 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) examples of each object type 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 b ooth 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 } } limitations 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