Get extracted-field summary

Aggregated values of every extracted field across the campaign’s calls.

GET /campaigns/{id}/business-intelligence

Get extracted-field summary

cURL

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

200

{
  "fields": [
    {
      "key": "<string>",
      "type": "<string>",
      "distribution": [
        {
          "value": "<string>",
          "count": 123
        }
      ],
      "stats": {
        "min": 123,
        "max": 123,
        "avg": 123,
        "count": 123
      }
    }
  ],
  "totalCallsWithExtraction": 123,
  "totalCallsWithoutExtraction": 123
}

Required scope: intel.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Response

200

application/json

OK

fields · object[] · required

Show child attributes

totalCallsWithExtraction · number · required

totalCallsWithoutExtraction · number · required