Get audience session

Get a single audience session for a page.

GET /v0/pages/{page_id}/audience_sessions/{audience_session_id}

Get audience session

cURL

curl --request GET \
  --url https://api.tryarchitect.com/v0/pages/{page_id}/audience_sessions/{audience_session_id} \
  --header 'x-api-key: <api-key>'

200

{
  "analyticsSessionId": "<string>",
  "audienceId": "<string>",
  "audienceSessionId": "<string>",
  "computationStatus": "pending",
  "formSubmissionEmail": "<string>",
  "formSubmissionId": "<string>",
  "formSubmissionIdentifier": "<string>",
  "formSubmissionIdentifierType": "email",
  "formSubmissionPhone": "<string>",
  "hasConversion": true,
  "hasFormSubmit": true,
  "isBounce": true,
  "maxScrollDepthPercentage": 123,
  "pageId": "<string>",
  "pageTitle": "<string>",
  "pageUrl": "<string>",
  "questionsAskedCount": 123,
  "sessionEndedAt": "<string>",
  "sessionStartedAt": "<string>",
  "timeSpentSeconds": 123,
  "totalClicksCount": 123,
  "utmCampaign": "<string>",
  "utmContent": "<string>",
  "utmMedium": "<string>",
  "utmSource": "<string>",
  "utmTerm": "<string>"
}

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

200

application/json

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 | null · required

Pattern: ^\+[1-9]\d{1,14}$

sessionStartedAt · string · required

Pattern: ^\+[1-9]\d{1,14}$

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