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.

Saved Reply Statistics

The saved reply statistics object contains a summary of saved replies that were most often sent over the specified date/time range(s).

Field Guide

Name Type Notes
count Long Number of saved replies sent for the current time range
top Collection Top saved replies the current time range, sorted from most to least sent
top[index].name String Name of this saved reply
top[index].id Long This saved reply's unique identifier
top[index].mailboxId Long The unique identifier for the mailbox associated with this saved reply
top[index].count Long Number of times this saved reply was sent for the current time range
top[index].previousCount Long Number of times this saved reply was sent for the previous time range; only included if a previous time range was specified
top[index].percent Double Percentage of total conversations in which this saved reply was used for the current time range
top[index].previousPercent Double Percentage of total conversations in which this saved reply was used for the previous time range; only included if a previous time range was specified
top[index].deltaPercent Double Change in percentage of total conversations in which this saved reply was used from the previous to current time ranges; only included if a previous time range was specified

Example

{
  "count": 109,
  "top": [
    {
      "name": "Saved Reply 1",
      "id": 1,
      "mailboxId": 1,
      "count": 16,
      "previousCount": 9,
      "percent": 0.88105726872247,
      "previousPercent": 0.43269230769231,
      "deltaPercent": 0.44836496103016
    },
    {
      "name": "Saved Reply 2",
      "id": 2,
      "mailboxId": 1,
      "count": 13,
      "previousCount": 12,
      "percent": 0.715859030837,
      "previousPercent": 0.57692307692308,
      "deltaPercent": 0.13893595391393
    },
    ...
  ]
}
↑Back to top
© Help Scout 2024