Tracking

List tracking sessions

GET /api/v1/tracking/sessions

List tracking sessions

Returns tracking sessions and their events visible to the authenticated account set.

Parameters

Name	In	Type	Description
`accountId`	query	integer[]	Filter by one or more internal account ids.
`accountExternalId`	query	string[]	Filter by one or more external account ids.
`agentId`	query	integer[]	Filter by one or more tracking agent ids.
`cursor`	query	string	Opaque cursor returned by the previous page.
`limit`	query	integer	Maximum number of sessions to return.

Responses

Status	Schema	Description
`200`	TrackingSessionList	Tracking session page
`400`	Error	Invalid query params
`401`	Error	Missing or invalid auth
`403`	Error	Requested filter falls outside the caller scope

Example 200 response

{
    "data": [
        {
            "id": 1,
            "agentId": 1,
            "sessionUuid": "string",
            "deviceUuid": "string",
            "internalIdentifier": "string",
            "startTime": "string",
            "lastActivity": "string",
            "engagementTime": 1,
            "userAgent": "string",
            "geoCountry": "string",
            "geoRegion": "string",
            "geoCity": "string",
            "geoIp": "string",
            "browserName": "string",
            "browserVersion": "string",
            "deviceType": "string",
            "deviceOs": "string",
            "deviceOsVersion": "string",
            "utmSource": "string",
            "utmMedium": "string",
            "utmCampaign": "string",
            "utmContent": "string",
            "utmTerm": "string",
            "referrerHost": "string",
            "referrerPath": "string",
            "trackingCompanyId": 1,
            "conversationId": 1,
            "events": [
                {
                    "id": 1,
                    "sessionId": 1,
                    "eventUuid": "string",
                    "eventName": "string",
                    "eventCreatedAt": "string",
                    "context": null,
                    "eventProperties": null,
                    "userProperties": null,
                    "meta": null,
                    "url": "string",
                    "title": "string",
                    "urlPath": "string",
                    "engagementTime": 1,
                    "formId": "string",
                    "formName": "string",
                    "createdAt": "string"
                }
            ],
            "createdAt": "string",
            "updatedAt": "string"
        }
    ],
    "pageInfo": {
        "hasNextPage": true,
        "endCursor": "string"
    }
}

Example 400 response

{
    "error": "string",
    "message": "string"
}

Example 401 response

{
    "error": "string",
    "message": "string"
}

Example 403 response

{
    "error": "string",
    "message": "string"
}