Skip to main content
GET
Overview stats

Authorizations

X-API-Key
string
header
required

API key for programmatic access. Keys use the format nl_live_<64 hex> or nl_test_<64 hex> and are scoped to an account's RBAC permissions.

Query Parameters

range
enum<string>
default:30d

Time range for analytics data

Available options:
7d,
30d,
90d

Response

Analytics overview

High-level analytics overview for the account.

totalLeads
integer
required

Total number of leads in the account

totalConversations
integer
required

Conversations started within the selected range

responseRate
integer
required

Percentage of conversations where the lead sent at least one message

avgMessages
number<float>
required

Average message count across conversations in range

completedRate
integer
required

Percentage of conversations with status completed

handedOffRate
integer
required

Percentage of conversations with status handed_off

sessionStatus
object
required
qualificationRate
integer
deprecated

Deprecated. Percentage of conversations with historical qualificationResult.qualified === true. Prefer completedRate / stage-distribution.

avgMessagesToQualify
number<float>
deprecated

Deprecated. Prefer avgMessages.