Count leads per segment

Per-metric lead segment counts, driven by the campaign evaluation metrics

GET /campaigns/{id}/lead-segments

Count leads per segment

cURL

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

200

{
  "totals": {
    "leads": 123,
    "scored": 123,
    "callbackDue": 123,
    "teamCallRequested": 123,
    "interested": 123,
    "reengaging": 123
  },
  "metrics": [
    {
      "key": "<string>",
      "label": "<string>",
      "builtin": true,
      "values": [
        {
          "value": "<string>",
          "label": "<string>",
          "count": 123
        }
      ]
    }
  ],
  "reason": "no_metrics"
}

Required scope: campaigns.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Query Parameters

days · integer

Required range: 1 <= x <= 365

Response

200

application/json

OK

totals · object · required

Show child attributes

metrics · object[] · required

Show child attributes

reason · enum<string>

Available options: no_metrics