Get contact funnel

Contacts, dialed, connected and completed counts.

GET /analytics/funnel

Get contact funnel

cURL

curl --request GET \
  --url https://api.pineyard.ai/analytics/funnel \
  --header 'Authorization: Bearer <token>'

200

{
  "contacts": 123,
  "dialed": 123,
  "connected": 123,
  "completed": 123,
  "totalCalls": 123
}

Required scope: analytics.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Query Parameters

days · integer

Required range: 1 <= x <= 365

campaignTypeId · string

campaignId · string

today · integer | null

Required range: 0 <= x <= 1

Response

200

application/json

OK

contacts · number · required

dialed · number · required

connected · number · required

completed · number · required

totalCalls · number · required