Skip to main content
GET
/
v0
/
pages
/
{page_id}
/
audience_sessions
List audience sessions
curl --request GET \
  --url https://api.tryarchitect.com/v0/pages/{page_id}/audience_sessions \
  --header 'x-api-key: <api-key>'
{
  "hasMore": true,
  "items": [
    {
      "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>"
    }
  ],
  "nextCursor": "<string>",
  "totalCount": 4503599627370495
}

Authorizations

​
x-api-key
string
header
required

API key authentication for the External Actor Gateway

Path Parameters

​
page_id
string
required

page_id parameter

Query Parameters

​
endDate
string<date-time>

endDate parameter

​
startDate
string<date-time>

startDate parameter

​
cursor
string

cursor parameter

​
limit
number

limit parameter

Response

200 - application/json

Successful operation

​
hasMore
boolean
required
​
items
object[]
required
​
nextCursor
string | null
required
​
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991