Get campaign call metrics

GET /campaigns/{id}/metrics

Get campaign call metrics

cURL

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

200

{
  "callPerformance": {
    "totalCalls": 123,
    "connectedCalls": 123,
    "connectionRatePercent": 123,
    "averageDurationSeconds": 123,
    "failedCalls": {
      "totalPercent": 123,
      "notReachable": {
        "count": 123,
        "percent": 123
      },
      "switchedOff": {
        "count": 123,
        "percent": 123
      },
      "busy": {
        "count": 123,
        "percent": 123
      }
    }
  },
  "conversationOutcomes": {
    "interested": {
      "count": 123,
      "percent": 123
    },
    "notInterested": {
      "count": 123,
      "percent": 123
    },
    "callBackLater": {
      "count": 123,
      "percent": 123
    },
    "invalidSpam": {
      "count": 123,
      "percent": 123
    },
    "other": {
      "count": 123,
      "percent": 123
    }
  },
  "callTimingInsights": {
    "pickupRateByHour": {},
    "pickupRateByDay": {},
    "bestTimeToCall": "<string>"
  }
}

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

callPerformance · object · required

Show child attributes

conversationOutcomes · object · required

Show child attributes

callTimingInsights · object · required

Show child attributes