Analytics

List top contacts by message volume

Returns the contacts your organization exchanged the most messages with over the selected date range.

GET
/v1/analytics/top-contacts

Returns the contacts your organization exchanged the most messages with over the selected date range. sortBy chooses the traffic messageCount reports and ranks by: sent counts outbound messages addressed to the contact, received counts inbound messages the contact sent you, and total (the default) counts both. Contacts with no traffic in the range are omitted, and at most 100 are returned.

x-api-key<token>

In: header

Query Parameters

startDate?|null
endDate?|null
limit?string|null
sortBy?|null

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/analytics/top-contacts"
[  {    "id": "string",    "name": "string",    "email": "string",    "phone": "string",    "messageCount": 0  }]

Related