Company Drill-Down

• REST Method: GET
• URLs: https://api.helpscout.net/v1/reports/company/drilldown.json

This report is similar to the Company Report, but instead of returning statistics about the company, it drills down and returns the conversation data that makes up the Company Report.

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.

Range

Valid values for the range parameter are listed below:

Range ID

Valid values for the rangeId parameters for each range value are listed below:

Examples

To find conversations with five or more replies for the month of January, send a request with these query parameters:

start=2015-01-01T00:00:00Z&end=2015-01-31T23:59:59Z&range=replies&rangeid=5

To find conversations that were resolved on the first reply for the month of January, send a request with these query parameters:

start=2015-01-01T00:00:00Z&end=2015-01-31T23:59:59Z&range=firstReplyResolved

Response

Each response contains one object called conversations.

Example Response

{
  "conversations": {
    "pages": 157,
    "page": 1,
    "count": 1561,
    "results": [
      {
        "id": 583,
        "number": 12345,
        "type": "email",
        "mailboxid": 2,
        "attachments": false,
        "subject": "Sample subject",
        "status": "active",
        "threadCount": 6,
        "preview": "This is a preview...",
        "customerName": "John Smith",
        "customerEmail": "john@example.com",
        "customerIds": [
          2
        ],
        "modifiedAt": "2015-04-24T18:59:49Z",
        "assignedid": 4,
        "tags": [
          {
            "id": 123,
            "name": "sample-tag",
            "color": "none"
          }
        ],
        "assignedName": "Mary Jones"
      },
      ...
    ]
  }
}