Skip to main content
GET
/
api
/
analytics
/
overview
Error
A valid request URL is required to generate request examples
{
  "totalLeads": 123,
  "newLeads": 123,
  "totalConversations": 123,
  "activeConversations": 123,
  "qualifiedLeads": 123,
  "disqualifiedLeads": 123,
  "qualificationRate": 123,
  "avgMessagesPerConversation": 123,
  "channelBreakdown": {
    "whatsapp": 123,
    "telegram": 123,
    "email": 123,
    "sms": 123
  }
}

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

newLeads
integer
required

Leads created within the selected range

totalConversations
integer
required

Total conversations started within the range

activeConversations
integer
required

Currently active conversations

qualifiedLeads
integer
required

Leads qualified within the range

disqualifiedLeads
integer
required

Leads disqualified within the range

qualificationRate
number<float>
required

Percentage of completed conversations resulting in qualification

avgMessagesPerConversation
number<float>
required

Average number of messages per conversation

channelBreakdown
object
required

Conversation counts by channel