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.

Tag Statistics

The tag statistics object contains a summary of which tags were used most frequently over the specified date/time range(s).

Field Guide

Name Type Notes
count Long Number of tags used for the current time range
top Collection Top tags used in the current time range, sorted from most to least used
top[index].id Long This tag's unique identifier
top[index].count Long Number of times this tag was used in the current time range
top[index].previousCount Long Number of times this tag was used the previous time range; only included if a previous time range was specified
top[index].percent Double Percentage of total conversations in which this tag was used for the current time range
top[index].previousPercent Double Percentage of total conversations in which this tag 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 tag was used from the previous to current time ranges; only included if a previous time range was specified

Example

{
  "count": 351,
  "top": [
    {
      "id": 1,
      "count": 1465,
      "previousCount": 1651,
      "percent": 80.671806167401,
      "previousPercent": 79.375,
      "deltaPercent": 1.2968061674009
    },
    {
      "name": "tag a",
      "id": 2,
      "count": 51,
      "previousCount": 63,
      "percent": 2.8083700440529,
      "previousPercent": 3.0288461538462,
      "deltaPercent": -0.22047610979329
    },
    {
      "name": "tag b",
      "id": 406031,
      "count": 24,
      "previousCount": 20,
      "percent": 1.3215859030837,
      "previousPercent": 0.96153846153846,
      "deltaPercent": 0.36004744154524
    },
    ...
  ]
}
↑Back to top
© Help Scout 2024