VocalDocscontracts 1.65.0

CampaignProgress

The progress of a Campaign (1.65.0; section 6): enrollments by status and disposition, attempts by result, reach, spend, opt-outs and per-arm results, counts and rates only.

An object with 16 fields.

Fields

FieldTypeRequiredDescription
armsarray of CampaignArmProgressyes
as_ofTimestampyes
attemptsCampaignAttemptCountsyes
campaign_idCampaignIdyes
enrollments_by_dispositionmap of integeryes
enrollments_by_statusmap of integeryes
estimated_completion_atTimestamp or nullyesAn estimate: remaining eligible enrollments over the current rate.
mean_attempts_to_reachnumber or nullyes
mean_duration_snumber or nullyes
numbers_throttledintegeryes
object"campaign_progress"yes
opt_outsintegeryes
reach_ratenumber or nullyes
spend_microsintegeryes
spend_per_reached_microsinteger or nullyes
statusCampaignStatusyes

Used by

The operations whose parameters, request body or responses name this shape directly.