Status Support Sign up

Campaigns

Get campaign stats

GET

/api/v1/campaigns/{campaignId}/stats

Path parameters

campaignId

required

string · uuid

Campaign id

Response

200Campaign progress, funnel, enrollments, and steps.

stats

object

progress

integer

funnel

object

enrolled	integer
skippedByReason	object
invitesSent	integer
invitesAccepted	integer
acceptanceRate	number \| null
messagesSent	integer
repliedLeads	integer
replyRate	number \| null

enrollments

object

active	integer
waiting	integer
completed	integer
stopped	integer
failed	integer
byExitReason	object

steps

object[]

requestId

string · uuid

Id of this request, for support and troubleshooting

Errors

400: Bad request
401: Unauthorized: missing or invalid API key
403: Forbidden
404: Not found
422: Invalid request payload

We use cookies to enhance your experience on Needle and keep your data secure. Privacy Policy