Legacy Mailbox API 1.0 is deprecated
Legacy Mailbox API 1.0 was deprecated on November 20, 2019. Please use Mailbox API 2.0 going forward. If you have any questions or need help with the new API, please reach out.
Customer Statistics
The customer statistics object contains a summary of the most active customers over the specified date/time range(s).
Field Guide
| Name | Type | Notes |
|---|---|---|
| count | Long | Total number of customer conversations for the current time range |
| top | Collection | Top customers for the current time range, sorted from most to least active |
| top[index].count | Long | Number of conversations for this customer in the current time range |
| top[index].deltaPercent | Double | Change in percentage of total conversations belonging to this customer from the previous to current time ranges; only included if a previous time range was specified |
| top[index].id | Long | This customer's unique identifier |
| top[index].name | String | This customer's full name |
| top[index].percent | Double | Percentage of total conversations belonging to this customer for the current time range |
| top[index].previousCount | Long | Number of conversations for this customer for the previous time range; only included if a previous time range was specified |
| top[index].previousPercent | Double | Percentage of total conversations belonging to this customer for the previous time range; only included if a previous time range was specified |
Example
{
"count": 1816,
"top": [
{
"count": 31,
"deltaPercent": 0.31281768891901,
"id": 1,
"name": "John Smith",
"percent": 1.7070484581498,
"previousCount": 29,
"previousPercent": 1.3942307692308
},
{
"count": 12,
"deltaPercent": -0.10843781768892,
"id": 2,
"name": "Mary Jones",
"percent": 0.66079295154185,
"previousCount": 16,
"previousPercent": 0.76923076923077
},
...
]
}