Skip to main content
GET
/
api
/
v1
/
businesses
/
{businessId}
/
tracking
/
sessions
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "utmSource": "<string>",
      "utmMedium": "<string>",
      "utmCampaign": "<string>",
      "utmTerm": "<string>",
      "utmContent": "<string>",
      "referrer": "<string>",
      "landingPage": "<string>",
      "lastSeen": "2023-11-07T05:31:56Z",
      "pageViews": [
        {}
      ],
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key prefixed with sk-ak-. Pass as Authorization: Bearer sk-ak-...

Path Parameters

businessId
string<uuid>
required

The business ID

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
contactId
string<uuid>
from
string<date-time>
to
string<date-time>
utmSource
string
utmMedium
string
utmCampaign
string
include
string

Include related data (e.g. "pageViews")

sort
enum<string>
default:-createdAt
Available options:
createdAt,
-createdAt,
lastSeen,
-lastSeen

Response

Paginated list of tracking sessions

data
object[]
pagination
object