Skip to main content
GET
Returns organization-level chat analytics: ticket, lead, and message totals, plus time-series engagement series.

Authentication

X-API-Key
string
required
Project API key for this organization. Format: bot_live_…

Path parameters

organization_id
string
required
Organization ID. Must match the API key.

Query parameters

start_date
datetime
Include data from this datetime (inclusive).
end_date
datetime
Include data until this datetime (inclusive).
project_id
string
Limit analytics to a single project.
channel_type
string
Filter by channel type (for example web, whatsapp, telegram).

Response

tickets
integer
required
Ticket count in scope.
leads
integer
required
Lead / new customer-profile identity count in scope.
messages
integer
required
Message count in scope.
user_engagement
array
required
Time-bucketed message engagement series (label, count).
session_growth
array
required
Time-bucketed lead / profile growth series (label, count).
lead_generation
array
Same growth series as session_growth (alias for clients).
group_by
string
required
Bucket size used for series: daily, weekly, monthly, or yearly (chosen from the date range).

Errors

401
Unauthorized
Missing, invalid, or revoked API key.
403
Forbidden
API key is not authorized for this organization.