Statistics
As its name indicates, the statistic resource allows you to retrieve statistics on the number of contacts in its database or from a particular list and also the number of contacts that can be reached for an SMS, Email, Push voice or message on answering machine sending.
List of properties of the statistic resource
|
Property |
Description |
|---|---|
|
subscribers |
Number of contacts present in the list |
|
sms |
Number of contacts that can be reached for an SMS sending.
As such, the following are not counted
|
|
|
Number of contacts that can be reached for an email sending.
As such, the following are not counted
|
|
voice |
Number of contacts that can be reached for a PUSH voice sending.
As such, the following are not counted
|
|
voicemail |
Number of contacts that can be reached for Message on answering machine sending. As such, the following are not counted
|
Example of the resource in JSON format
|
{ "subscribers": "103456", "sms": "100003", "email": "45689", "voice": "564", "voicemail": "1065", } |
Retrieving statistics
Filters available
|
Filter |
Description |
|---|---|
|
listId |
Filter according to one or more contact list ids |
Additional parameter
|
Filter |
Description |
|---|---|
|
priorities |
This parameter allows you to know the number of email addresses, mobile telephone or fixed telephones in the framework of substitution1.
Possible values of the priorities table: SMS, EMAIL, VOICE, VOICEMAIL
Note: For the media not present in the priorities list, the number of contacts that can be reached for these forms of media will be equal to 0. |
1Substitution is the principle of prioritizing the communication channels for a multichannel marketing campaign. For example, building a campaign where SMS is prioritized with respect to email will result in sending an SMS to all of the contacts that have a mobile telephone, then in sending an email to all of the contacts that have an email address but no mobile telephone number.
Return
Contrary to the read methods of the other resources, it is not a list that is returned but a single resource.
Example
Retrieving the number of mobile telephones or email addresses that can be reached by prioritizing SMS
|
curl -X GET -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...ccOqbVow8xOQyQ" -d listId=7606 -d priorities=SMS,EMAIL |