Company Customers Helped

The customers helped report provides statistics about how many customers were helped over a given time range. You may optionally specify two time ranges to see how the number of customers helped changed between the two ranges.

Request

GET /v2/reports/company/customers-helped HTTP/1.1
Authorization: Bearer oauth_token

URL Parameters

Parameter Description
start Start of the interval
end End of the interval
previousStart Start of the previous interval
previousEnd End of the previous interval
mailboxes List of comma separated ids to filter on mailboxes
tags List of comma separated ids to filter on tags
types List of comma separated conversation types to filter on, valid values are email, chat, phone
folders List of comma separated folder ids to filter on folders
viewBy Represents the resolution at which data is returned; valid values are:
day (only allowed if time range is <= 60 days)
week (only allowed if time range is <= 1 year)
month (only allowed if time range is >= 61 days)

Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "current" : [ {
    "date" : "2017-01-01T12:00:00Z",
    "customers" : 2254
  }, {
    "date" : "2017-02-01T12:00:00Z",
    "customers" : 2101
  }, {
    "date" : "2017-03-01T12:00:00Z",
    "customers" : 2189
  }, {
    "date" : "2017-04-01T12:00:00Z",
    "customers" : 2103
  }, {
    "date" : "2017-05-01T12:00:00Z",
    "customers" : 2086
  }, {
    "date" : "2017-06-01T12:00:00Z",
    "customers" : 2043
  }, {
    "date" : "2017-07-01T12:00:00Z",
    "customers" : 2071
  }, {
    "date" : "2017-08-01T12:00:00Z",
    "customers" : 2284
  }, {
    "date" : "2017-09-01T12:00:00Z",
    "customers" : 2005
  }, {
    "date" : "2017-10-01T12:00:00Z",
    "customers" : 118
  }, {
    "date" : "2017-11-01T12:00:00Z",
    "customers" : 0
  } ],
  "previous" : [ {
    "date" : "2016-01-01T12:00:00Z",
    "customers" : 2254
  }, {
    "date" : "2016-02-01T12:00:00Z",
    "customers" : 2101
  }, {
    "date" : "2016-03-01T12:00:00Z",
    "customers" : 2189
  }, {
    "date" : "2016-04-01T12:00:00Z",
    "customers" : 2103
  }, {
    "date" : "2016-05-01T12:00:00Z",
    "customers" : 2086
  }, {
    "date" : "2016-06-01T12:00:00Z",
    "customers" : 2043
  }, {
    "date" : "2016-07-01T12:00:00Z",
    "customers" : 2071
  }, {
    "date" : "2016-08-01T12:00:00Z",
    "customers" : 2284
  }, {
    "date" : "2016-09-01T12:00:00Z",
    "customers" : 2005
  }, {
    "date" : "2016-10-01T12:00:00Z",
    "customers" : 118
  }, {
    "date" : "2016-11-01T12:00:00Z",
    "customers" : 0
  } ]
}

Response fields

Path Type Description
current Array Contains data points describing the number of customers helped for the current time range
previous Array Contains data points describing the number of customers helped for the previous time range. Only included if a previous time range was specified

Data points

Path Type Description
[].customers Number The number of customers helped from date until the duration specified by viewBy
[].date String The beginning date represented by this data point