Analytics

List top contacts by message volume

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.

get/v1/analytics/top-contacts

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/analytics/top-contacts
  • Auth: API key in header x-api-key

Query parameters

afterstring nullable
beforestring nullable
limitstring nullable
sortBy'sent' | 'received' | 'total' nullable

Response

Success

idstring required
namestring nullable required
emailstring nullable required
phonestring nullable required
messageCountinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.