Get component event totals

GET

/api/v1/insights/components/events

Engagement totals per personalization variation: views, CTA clicks, closes, and the AI chat counters (responses, unanswered responses, searches, conversations, sessions, thumbs up/down, escalations).

Parameters

Header Parameters

x-api-key

required

string

Your API key from account settings.

x-user-email

required

string

The email address of your user.

x-account-id

required

string

The ID of your account. You can find this in the account settings.

x-website-id

required

string

The ID of the workspace you want to use.

Query Parameters

startTime

required

string format: date

First day of the range, inclusive, as YYYY-MM-DD.

endTime

required

string format: date

Last day of the range, inclusive, as YYYY-MM-DD.

forceRefresh

boolean

Recompute instead of reading the query cache. Slow - only worth it when you know the cache is stale.

Responses

200

Totals per variation.

object

status

string

lastUpdate

number

personalizations

Array<object>

Engagement counters for one personalization variation, split by new versus returning visitors.

object

day

string

variationId

string

variationName

string

new

object

views

number

primaryctaclicks

number

secondaryctaclicks

number

closes

number

chatresponses

number

chatunansweredresponses

Responses where the AI could not answer.

number

chatsearches

number

chatconversations

number

chatstartingresponses

number

chatconversationswithoutstartingmessage

number

chatsessions

Derived from chatstartingresponses plus chatconversationswithoutstartingmessage.

number

chatpositives

number

chatnegatives

number

chatescalations

number

successratio

number

isReturning

object

views

number

primaryctaclicks

number

secondaryctaclicks

number

closes

number

chatresponses

number

chatunansweredresponses

Responses where the AI could not answer.

number

chatsearches

number

chatconversations

number

chatstartingresponses

number

chatconversationswithoutstartingmessage

number

chatsessions

Derived from chatstartingresponses plus chatconversationswithoutstartingmessage.

number

chatpositives

number

chatnegatives

number

chatescalations

number

successratio

number

401

Unauthorized - invalid API key.

500

StartTime or endTime was missing.