Skip to main content
GET
/
api
/
analytics
/
campaigns
Error
A valid request URL is required to generate request examples
[
  {
    "campaignId": "<string>",
    "campaignName": "<string>",
    "channel": "whatsapp",
    "status": "draft",
    "totalLeads": 123,
    "sent": 123,
    "replied": 123,
    "qualified": 123,
    "disqualified": 123,
    "failed": 123,
    "replyRate": 123,
    "qualificationRate": 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.

Response

Campaign performance stats

​
campaignId
string
required

Campaign identifier

​
campaignName
string
required

Campaign display name

​
channel
enum<string>
required

Messaging channel used

Available options:
whatsapp,
telegram,
email
​
status
enum<string>
required

Current campaign status

Available options:
draft,
scheduled,
running,
paused,
completed
​
totalLeads
integer
required

Total leads targeted

​
sent
integer
required

Messages successfully sent

​
replied
integer
required

Leads that replied

​
qualified
integer
required

Leads that were qualified

​
disqualified
integer
required

Leads that were disqualified

​
failed
integer
required

Leads where outreach failed

​
replyRate
number<float>
required

Percentage of sent messages that received a reply

​
qualificationRate
number<float>
required

Percentage of replied leads that were qualified