Skip to navigation

Get product conversations by end user

Rank the verified end users of a product by widget conversations (or messages) started in the window. Conversations from visitors without a verified identity are reported as a separate unattributed total. Known limitation: a conversation linked to its end user only through the widget visitor (not stamped with the end user itself, as in product- or tenant-scoped surfaces) loses that link when the visitor is deleted after its idle TTL (default 90 days, configurable via visitorIdleDays). Such conversations then move from that end user to the unattributed total, so counts for older windows can drop over time.

Authentication

AuthorizationBearer
API key or Clerk session token

Query parameters

productIdstringRequired>=1 character
productTenantIdstringOptional>=1 character
periodenumOptional
Allowed values:
daysintegerOptional1-93
sortenumOptionalDefaults to conversations
Allowed values:
limitintegerOptional1-200Defaults to 50

Response

End-user conversation breakdown

attributedobject
endUserslist of objects
generatedAtstring
periodobject
scopeobject
totalsobject
unattributedobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error