Skip to main content
GET
Get per-end-user widget usage
Per-end-user usage for your embedded widget over a time window — messages, distinct chats, last activity, and live quota counters for the limits you sign into each visitor’s widget JWT. Build partner dashboards or your own billing on top of it. The external_id of each row is the sub you signed into that visitor’s widget token — see the widget guide for how sessions are issued.

Authorizations

Authorization
string
header
required

A cb_live_ API token, created in the panel under API Tokens.

Query Parameters

days
integer
default:30

Number of days to include in the usage window.

limit
integer
default:100

Maximum number of end-users to return.

Response

Successful Response

Per-end-user widget usage for the requested window.

period_days
integer
required

Length of the usage window, in days.

quota_enforced
boolean
required

Whether live quota counting is active for this organization.

users
EndUserUsage · object[]
required

One row per end-user seen in the window.