Campaigns

A campaign's progress counts

GET /v1/campaigns/{campaign_id}/progress

Scope

campaigns:read

Tier

Tier 1

Data

Account data

Idempotency

Idempotency-Key: not used

Four counts, deliberately not one percentage: attempted_leads is not reached_leads. Reached means positive evidence that a person was on the call.

Parameters

Response

200: The counts.

Examples

Request example

curl

curl -sS -X GET \
  "https://app.dialerbee.com/api/v1/campaigns/cmp_0f8fad5b-d9cb-469f-a165-70867728950e/progress" \
  -H "Authorization: Bearer $DIALERBEE_API_KEY"

Python (SDK)

from dialerbee import DialerBee

db = DialerBee()  # reads DIALERBEE_API_KEY from the environment

result = db.campaigns.progress("cmp_0f8fad5b-d9cb-469f-a165-70867728950e")

Response example

200

{
  "campaign_id": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e",
  "status": "paused",
  "total_leads": 1200,
  "attempted_leads": 640,
  "reached_leads": 310,
  "pending_leads": 560
}

Error examples

403 insufficient_scope

{
  "type": "https://docs.dialerbee.com/errors/insufficient-scope",
  "title": "Not permitted",
  "status": 403,
  "detail": "The API client does not hold the scope this operation requires.",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "insufficient_scope",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

401 invalid_api_key

{
  "type": "https://docs.dialerbee.com/errors/invalid-api-key",
  "title": "Invalid API key",
  "status": 401,
  "detail": "The Authorization header is missing, is not Bearer dbk_live_..., or the key is not recognised, has expired or was revoked (one answer for every key problem, so a key's state is never revealed).",
  "instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
  "code": "invalid_api_key",
  "request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}

Errors

Objects

CampaignProgress