List leads by evaluation segment

Filter + priority-sort connected leads by evaluation metrics (Leads tab)

GET /campaigns/{id}/segmented-leads

List leads by evaluation segment

cURL

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

200

{
  "items": [
    {
      "callId": "<string>",
      "contactId": "<string>",
      "name": "<string>",
      "toNumber": "<string>",
      "status": "<string>",
      "outcome": "<string>",
      "durationMs": 123,
      "attemptNumber": 123,
      "dialReason": "<string>",
      "attemptCount": 123,
      "queuedAt": "<string>",
      "receivedAt": "<string>",
      "firstCallInitiatedAt": "<string>",
      "waitMs": 123,
      "isApiLead": true,
      "interestLevel": "<string>",
      "qualification": "<string>",
      "callbackAt": "<string>",
      "metrics": {},
      "fields": {},
      "priorityRank": 123,
      "doNotCall": true,
      "disposition": "<string>",
      "leadTags": [
        "<string>"
      ],
      "whatsappState": "NEEDS_REPLY",
      "whatsappLastMessageAt": "<string>"
    }
  ],
  "total": 123
}

Required scope: intel.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Query Parameters

limit · integer

Required range: 1 <= x <= 200

offset · integer | null

Required range: x >= 0

interestLevel · string[] | null

Maximum array length: 20

qualification · string[] | null

Maximum array length: 20

callResult · string[] | null

Maximum array length: 20

callbackDue · boolean | null

search · string

mf · string[] | null

Maximum array length: 20

Pattern: ^[^:]+:.+$

sort · enum<string>

Available options: priority, recent, duration, attempts

minDurationSec · integer | null

Required range: 0 <= x <= 86400

maxDurationSec · integer | null

Required range: 0 <= x <= 86400

minAttempts · integer | null

Required range: 0 <= x <= 100

calledFrom · string

calledTo · string

includeUnscored · boolean | null

disposition · string[] | null

Maximum array length: 20

tags · string[] | null

Maximum array length: 20

whatsapp · enum<string>

Available options: messaged, needs_reply, replied, read, delivered, failed

Response

200

application/json

OK

items · object[] · required

Show child attributes

total · number · required