Campaign tracking

Get per step progress

For each step id: how many contacts already passed the step (completed) and how many are currently waiting at it (waiting). Works on paused campaigns. Returns {} for a DRAFT or unknown campaign.

get/advanced/campaigns/{campaignId}/progress

Request

  • Base URL: https://api.emelia.io
  • URL: https://api.emelia.io/advanced/campaigns/{campaignId}/progress
  • Auth: API key in header Authorization

Path parameters

campaignIdstring required

MongoDB ObjectId: 24 hexadecimal characters.

Example:6650f1a2b839d80011c5a0f1

Identifier of a multichannel campaign (24 hexadecimal characters), as returned by POST /advanced/campaigns or GET /advanced/campaigns.

Response

Success.

successunknown
progressobject

Changes

No recorded changes to this operation across all 1 revision of this API.