Get campaign KPIs

GET /campaigns/{id}/kpis

Get campaign KPIs

cURL

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

200

{
  "contacts": 123,
  "dialedContacts": 123,
  "reachedContacts": 123,
  "pickedUpContacts": 123,
  "placed": 123,
  "connectRate": 123,
  "pickupRate": 123,
  "avgDurationMs": 123,
  "pending": 123,
  "completed": 123,
  "failed": 123,
  "reengaging": 123,
  "triggered": 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

contacts · number · required

dialedContacts · number · required

reachedContacts · number · required

pickedUpContacts · number | null · required

placed · number · required

connectRate · number · required

pickupRate · number | null · required

avgDurationMs · number · required

pending · number · required

completed · number · required

failed · number · required

reengaging · number · required

triggered · number | null · required