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.

Workflow Statistics

The workflow statistics object contains a summary of which workflows were triggered over the specified date/time range(s).

Field Guide

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

Example

{
  "count": 240,
  "top": [
    {
      "name": "Workflow 1",
      "id": 1,
      "count": 90,
      "previousCount": 82,
      "percent": 4.9559471365639,
      "previousPercent": 3.9423076923077,
      "deltaPercent": 1.0136394442562
    },
    {
      "name": "Workflow 2",
      "id": 2,
      "count": 75,
      "previousCount": 91,
      "percent": 4.1299559471366,
      "previousPercent": 4.375,
      "deltaPercent": -0.24504405286344
    },
    ...
  ]
}
↑Back to top
© Help Scout 2021