Get campaign progress

Contact counts by status (PENDING, IN_FLIGHT, MESSAGED, COMPLETED, FAILED, SKIPPED). Inbound campaigns return call counts instead.

GET /campaigns/{id}/stats

Get campaign progress

cURL

curl --request GET \
  --url https://api.pineyard.ai/campaigns/{id}/stats \
  --header 'Authorization: Bearer <token>'

200

{
  "status": "<string>",
  "total": 123,
  "PENDING": 123,
  "IN_FLIGHT": 123,
  "COMPLETED": 123,
  "FAILED": 123,
  "SKIPPED": 123,
  "MESSAGED": 123,
  "receivedCalls": 123,
  "active": 123,
  "completed": 123,
  "failed": 123,
  "noAnswerBusy": 123,
  "queued": 123,
  "retrying": 123,
  "creditsUsed": 123,
  "avgDurationMs": 123,
  "concurrency": {
    "max": 123
  },
  "journey": {
    "workflowId": "<string>",
    "outcomes": [
      {
        "endLabel": "<string>",
        "count": 123
      }
    ],
    "needsAttention": 123
  }
}

Required scope: campaigns.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Response

200

application/json

OK

status · string · required

total · number · required

PENDING · number · required

IN_FLIGHT · number · required

COMPLETED · number · required

FAILED · number · required

SKIPPED · number · required

MESSAGED · number

receivedCalls · number

active · number

completed · number

failed · number

noAnswerBusy · number

queued · number

retrying · number

creditsUsed · number

avgDurationMs · number

concurrency · object

Show child attributes

journey · object

Show child attributes