We're upgrading our API
On June 6th, 2019, Mailbox API 1.0 will be sunsetted, and at that time any apps using this legacy API will no longer work. Please use Mailbox API 2.0 instead.
Customers Helped
- REST Method: GET
- URLs: https://api.helpscout.net/v1/reports/company/customers-helped.json
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.
URL Parameters
A variety of filters are available as query parameters. Including any of these will result in only conversations that match the filters being included in the report.
| Parameter | Type | Required | Notes | Example |
|---|---|---|---|---|
| start | Date/Time | Yes | ISO 8601, in UTC | 2015-01-01T00:00:00Z |
| end | Date/Time | Yes | ISO 8601, in UTC | 2015-01-31T23:59:59Z |
| previousStart | Date/Time | No | ISO 8601, in UTC | 2014-01-01T00:00:00Z |
| previousEnd | Date/Time | No | ISO 8601, in UTC | 2014-01-31T23:59:59Z |
| mailboxes | list of mailbox identifiers | No | 1,2,3 | |
| tags | list of tag identifiers | No | 1,2,3 | |
| types | list of conversation types (email, chat, or phone) | No | Valid values are:
|
email,chat |
| folders | list of folder identifiers | No | 1,2,3 | |
| viewBy | String | No | Represents the resolution at which data is returned; valid values are:
|
week |
Response
| Response | Name | Type | Notes |
|---|---|---|---|
| Header | Status | Int | 200 |
| Body | previous | Collection | Contains data points describing the number of customers helped for the previous time range; each data point contains these fields:
|
| current | Collection | Contains data points describing the number of customers helped for the current time range; each data point contains these fields:
|
Example Response
{
"previous": [
{
"customers": 310,
"date": "2013-01-01T00:00:00Z"
},
...
],
"current": [
{
"customers": 27,
"date": "2014-01-01T00:00:00Z"
},
...
]
}