GET
/
api
/
public
/
analytics
/
contacts
Get contacts info
curl --request GET \
  --url https://api.vambe.me/api/public/analytics/contacts \
  --header 'x-api-key: <x-api-key>'
{
  "count": 123,
  "lastPeriodCount": 123
}

Headers

​
x-api-key
string
required

API key

Query Parameters

​
page
string
required

Page number

Example:

"1"

​
orderBy
enum<string>
required

Order by

Available options:
contact_created_at,
ticket_created_at,
last_inbound_message,
last_outbound_message,
id
​
channel
enum<string>
required
Available options:
whatsapp,
playground,
instagram,
webchat,
web-whatsapp,
messenger,
sms
​
pipelineId
string
​
status
enum<string>
Available options:
unattended,
attended,
ai-attended,
ai-away

Response

200 - application/json

Returns contacts info

​
count
number

Number of new contacts in current period

​
lastPeriodCount
number

Number of new contacts in previous period