Skip to content
Vocapable Developers

Read workspace campaign totals and recent call activity

GET
/v1/campaigns/overview
curl --request GET \
  --url 'https://api.vocapable.com/v1/campaigns/overview?start=2026-04-15T12%3A00%3A00Z&end=2026-04-15T12%3A00%3A00Z' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
start
required
Start

Inclusive start, with timezone offset.

string format: date-time

Inclusive start, with timezone offset.

end
required
End

Exclusive end; maximum window 93 days.

string format: date-time

Exclusive end; maximum window 93 days.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CampaignOverview

Current statuses plus outbound campaign call records started in [start, end).

object
start
required
Start
string format: date-time
end
required
End
string format: date-time
as_of
required
As Of
string format: date-time
total_campaigns
required
Total Campaigns
integer
status_counts
required
Status Counts
Array<object>
CampaignStatusCount
object
status
required
CampaignStatus
string
Allowed values: draft scrubbing ready running paused completed cancelled
count
required
Count
integer
calls_started
required
Calls Started
integer
campaigns_with_calls
required
Campaigns With Calls
integer
most_active
required
Most Active
Array<object>
CampaignActivity
object
campaign_id
required
Campaign Id
string
name
required
Name
string
status
required
CampaignStatus
string
Allowed values: draft scrubbing ready running paused completed cancelled
workflows
required
Workflows
Array<string>
calls_started
required
Calls Started
integer
last_call_at
required
Last Call At
string format: date-time
most_active_limit
required
Most Active Limit
integer
>= 1
Example
{
  "status_counts": [
    {
      "status": "draft"
    }
  ],
  "most_active": [
    {
      "status": "draft"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}