Skip to main content
GET
/
campaigns
/
{campaignId}
/
stats
Campaign performance stats
curl --request GET \
  --url https://origami.chat/api/v2/campaigns/{campaignId}/stats \
  --header 'Authorization: Bearer <token>'
{
  "object": "<string>",
  "found": 123,
  "contacted": 123,
  "hasEmail": true,
  "hasLinkedin": true,
  "connectAccepted": 123,
  "connectSent": 123,
  "connectionRate": 123,
  "replied": 123,
  "replyRate": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
campaignId
string<uuid>
required

The campaign id (a first-class campaigns row).

Response

The campaign_stats object.

Headline engagement stats for a campaign.

​
object
string
required
Allowed value: "campaign_stats"
​
found
integer
required

People enrolled in the campaign.

​
contacted
integer
required

People actually reached (≥1 sent/accepted message).

​
hasEmail
boolean
required
​
hasLinkedin
boolean
required
​
connectAccepted
integer
required
​
connectSent
integer
required
​
connectionRate
number
required
​
replied
integer
required
​
replyRate
number
required