contacts

Get contact funnel statistics

Changed on

Counts for the list: people in it, people removed, source, and daily trends.

get/contacts/stats

Request

  • Base URL: https://api.bereach.ai
  • URL: https://api.bereach.ai/contacts/stats
  • Auth: HTTP bearer

Query parameters

campaignIdstring

Filter stats by campaign

Response

Contact statistics

successtrue required
foundPeopleinteger required

Everyone found, each person counted once, not counting removed. The funnel counts a person once per list they are on.

bySourceobject required
bySourceAngleobject required
byCampaignobject required
creditsUsedinteger required

Credits this call spent, net of anything given back. 0 when nothing was charged: a free read, a cached answer, nothing delivered.

retryAfterinteger required

Seconds to wait before another call of the same type. 0 means no wait is needed.

Changes