Tracking sessions

Tracking sessions: available fields, filters, associations, and API operations.

Operations

Event-level resource. Every operation requires an enabled Core API scope for this resource and access to the URL context.

GETList records

/api/core/organizations/123/events/456/tracking-sessions

Permission: Read access. Readable fields, query filters and related objects must be selected in the scope.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request GET \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/tracking-sessions' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}"

Response: 200 OK. A JSON:API data array and pagination metadata. Default page size 30; maximum 100.

View response structure

{
  "data": [
    {
      "id": "1201",
      "type": "tracking-session"
    }
  ],
  "meta": {
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

Illustrative, with no additional response fields selected.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 429 for rate limits. Troubleshooting and retry guidance.

GETGet a record

/api/core/organizations/123/events/456/tracking-sessions/1201

Permission: Read access. Readable fields, query filters and related objects must be selected in the scope.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request GET \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/tracking-sessions/1201' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}"

Response: 200 OK. A JSON:API data object; fields depend on the token scope.

View response structure

{
  "data": {
    "id": "1201",
    "type": "tracking-session"
  }
}

Illustrative, with no additional response fields selected.

Path: events/{event_id}/tracking-sessions
Methods: GET collection/record only.

Browse 9 response fields

The scope chooses these response fields. id is always returned. Configuration names and response names can differ.

event-id: Scope field: event_id
registrant-id: Scope field: registrant_id
trackable-type: Scope field: trackable_type
trackable-id: Scope field: trackable_id
click-count: Scope field: click_count
view-count: Scope field: view_count
duration-seconds: Scope field: duration_seconds
created-at: Scope field: created_at
updated-at: Scope field: updated_at

Filters: registrant_id, trackable_type, trackable_id, created_from, created_to, sponsor_id.
Association: tracking_session_slices → response slices, with tracking-type, click-time, start-time, end-time, duration-seconds.
Row restriction: named sponsor, limiting results to selected sponsor-owned tracking activity.

GET .../tracking-sessions?sponsor_id=103705&include=slices

POST, PATCH, and DELETE are not available.