Campaigns
Campaign counts and booked value by status
Powers the KPI card row on the Campaigns screen.
A campaign is included in the period if its date range overlaps with the requested period (start_date <= period_end AND end_date >= period_start). Contract value is resolved from the latest LeadContract on the parent lead.
| Field | Definition |
|---|---|
active | node != NODE_SALES_END AND not in a global action status |
on_hold | status = 'Pause' (global workflow pause action) |
cancelled | status = 'Cancelled' (global workflow reject action) |
completed | node = 'NODE_SALES_END' (terminal workflow node) |
active_booked_value | Sum of contract values for active campaigns |
completed_value | Sum of contract values for completed campaigns |
Note:
collected_valueis not available here — payment data lives in the payment service. Useactive_booked_valueas the booked figure.
GET
Campaign counts and booked value by status
Authorizations
Enter your JWT token in the format: Bearer
Query Parameters
Period string. Accepted formats:
2026-05— calendar monthQ2-2026— quarter (Q1–Q4)YTD-2026— year to date
Response
200 - application/json
Pattern:
^-?\d{0,16}(?:\.\d{0,2})?$Pattern:
^-?\d{0,16}(?:\.\d{0,2})?$Pattern:
^-?\d{0,4}(?:\.\d{0,1})?$Campaign counts and booked value by status
