Get a campaign's outreach progress

GET

/campaigns/{id}/outreach

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

idstringrequired

Campaign id.

Response

application/json

Success

campaign_idstringrequired

sequence_versioninteger | nullrequired

Latest sequence version; null when the campaign has none yet.

enrollmentsobjectrequired

How many of the campaign's leads are in each sequence state.

next_actionsobject[]required

Up to 10 leads with the next steps due, soonest first.

Get a campaign's outreach progress

curl --request GET \
  --url https://api.bavlio.com/campaigns/{id}/outreach \
  --header 'Authorization: Bearer <token>'

curl --request GET \  --url https://api.bavlio.com/campaigns/{id}/outreach \  --header 'Authorization: Bearer <token>'

{
  "campaign_id": "<string>",
  "sequence_version": 123,
  "enrollments": {
    "active": 123,
    "waiting": 123,
    "paused": 123,
    "stopped": 123,
    "completed": 123
  },
  "next_actions": [
    {
      "lead_id": "<string>",
      "lead_name": "<string>",
      "lead_stage": "found",
      "step_id": "<string>",
      "kind": "visit_profile",
      "state": "active",
      "at": "<string>"
    }
  ]
}

{  "campaign_id": "<string>",  "sequence_version": 123,  "enrollments": {    "active": 123,    "waiting": 123,    "paused": 123,    "stopped": 123,    "completed": 123  },  "next_actions": [    {      "lead_id": "<string>",      "lead_name": "<string>",      "lead_stage": "found",      "step_id": "<string>",      "kind": "visit_profile",      "state": "active",      "at": "<string>"    }  ]}