Skip to main content
GET
Get audience session

Authorizations

x-api-key
string
header
required

API key authentication for the External Actor Gateway

Path Parameters

page_id
string
required

page_id parameter

audience_session_id
string
required

audience_session_id parameter

Response

Successful operation

analyticsSessionId
string
required
audienceId
string | null
required
audienceSessionId
string | null
required
computationStatus
enum<string>
required
Available options:
pending,
completed,
failed
formSubmissionEmail
string | null
required
formSubmissionId
string | null
required
formSubmissionIdentifier
string | null
required
formSubmissionIdentifierType
enum<string> | null
required
Available options:
email,
linkedin,
tel
formSubmissionPhone
string | null
required
hasConversion
boolean
required
hasFormSubmit
boolean
required
isBounce
boolean
required
maxScrollDepthPercentage
number | null
required
pageId
string | null
required
pageTitle
string | null
required
pageUrl
string | null
required
questionsAskedCount
number
required
sessionEndedAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
sessionStartedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
timeSpentSeconds
number | null
required
totalClicksCount
number
required
utmCampaign
string | null
required
utmContent
string | null
required
utmMedium
string | null
required
utmSource
string | null
required
utmTerm
string | null
required