Read a Campaign's progress

GET /v1/campaigns/{campaign_id}/progress

Answers the progress of a Campaign (1.65.0; section 6): enrollments by status and disposition, attempts by result, reach, spend, opt-outs, the per-arm results with intervals, and an estimated completion labelled an estimate. Counts only; a draft answers zeros.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the campaigns:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/campaigns/cmp_.../progress" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/campaigns/cmp_.../progress`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/campaigns/cmp_.../progress",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is CampaignProgress.