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.

Custom Fields Statistics

Applicable to dropdown custom fields only

The custom fields statistics object contains a summary of which custom field values were filled in the specified date/time range(s).

Field Guide

Name Type Notes
fields Collection Custom fields used in conversations from the specified date/time range
count Long Number of custom fields in the report
fields[index].id Long This custom field's unique identifier
fields[index].name String This custom fields's name
fields[index].mailbox Long Identifier of the mailbox where this custom field is defined
fields[index].values Collection Collection of all custom fields values
fields[index].values[index].name String Name of selected dropdown field value
fields[index].values[index].id Long Unique identifier of a dropdown option
fields[index].values[index].count Long Number of answered conversations where this custom field's value was set
fields[index].values[index].previousCount Long Number of answered conversations where this custom field's value was set in the previous date/time range
fields[index].values[index].percent Double Percentage of total conversations in which this custom field value was set
fields[index].values[index].previousPercent Double Percentage of total conversations in which this custom field value was set in the previous date/time range
fields[index].values[index].deltaPercent Double Percentage change between current and previous date/time range
fields[index].summary Object Summary statistics
fields[index].summary.total Long Total number of conversations where this custom if available.
fields[index].summary.totalAnswered Long Number of conversations where this custom field has an answer/value
fields[index].summary.previousTotal Long Total of conversation where this custom field could have been answered in the previous date/time range
fields[index].summary.previousTotalAnswered Long Number of conversations where this custom field has an answer/value in the previous date/time range
fields[index].summary.unansweredDelta Double Percentage change between current and previous date/time range for unanswered conversations
fields[index].summary.unansweredPercent Double Percentage of conversations where this custom field has no answer/value
fields[index].summary.previousUnansweredPercent Double Percentage of conversations where this custom field has no answer/value in the specified previous date/time range

Example

{
  "customFields": {
    "count" : 1,
    "fields": [
      {
        "id": 8,
        "name": "Account Type",
        "mailboxId": 1234,
        "values": [
          {
            "name": "Paying Customer",
            "id": 7,
            "count": 1442,
            "percent": 55.12232415902141
          },
          {
            "name": "Trial Customer",
            "id": 11,
            "count": 273,
            "percent": 10.435779816513762
          }
        ],
        "summary": {
          "total": 2616,
          "totalAnswered": 2241,
          "previousTotal": null,
          "previousTotalAnswered": null,
          "unansweredDelta": 14.3348623853211,
          "unansweredPreviousPercent": 0,
          "unansweredPercent": 14.3348623853211
        }
      }
    ]
  }
}
↑Back to top
© Help Scout 2024