CAcarecycle
Campaigns

Get Campaign Pulse Occupancy

See how many customers are at each step of a campaign's workflow right now.

get/v2/campaigns/{campaignId}/pulse-occupancy

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/campaigns/{campaignId}/pulse-occupancy
  • Auth
    API key in header x-api-key

Path parameters

campaignIdstring uuid required

Campaign ID

Response

GET /v2/campaigns/:campaignId/pulse-occupancy Positive response

campaignIdstring uuid required
generatedAtstring date-time required
totalMappedCustomersnumber required

Customers currently mapped onto workflow nodes.

unmappedCustomersnumber required

Active, non-terminal customers in the campaign without a current mapped Pulse node.

Changes

No recorded changes to this operation across all 2 revisions of this API.