User Drill-down

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

Note: The reporting endpoints are only available to Plus and Pro plans.

Request

GET /v2/reports/user/drilldown HTTP/1.1
Authorization: Bearer oauth_token

URL Parameters

Parameter Type Examples Description
start date start=2019-05-02T12:00:00Z
 Start of the interval
end date end=2019-06-02T12:00:00Z
 End of the interval
user number user=447723
 User for whom the report is generated
mailboxes number mailboxes=123
mailboxes=123,567
 List of comma separated ids to filter on mailboxes
tags number tags=99787
tags=5666,99787
 List of comma separated ids to filter on tags
types enumeration types=email
 List of comma separated conversation types to filter on, valid values are email, chat, phone
folders number folders=991
folders=991,992
 List of comma separated folder ids to filter on folders
page number page=2
 The page number
rows number rows=30
 Number of result to return per page; defaults to 25; maximum is 50

Response

HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=890A57924D15595ABD960E04E69BE508; Path=/; HttpOnly
Content-Type: application/json

{
  "conversations" : {
    "count" : 101,
    "page" : 1,
    "pages" : 11,
    "results" : [ {
      "id" : 430221821,
      "number" : 226358,
      "type" : "email",
      "mailboxid" : 85,
      "attachments" : false,
      "subject" : "Folder Not Appearing",
      "status" : "active",
      "threadCount" : 3,
      "preview" : "Hi Reginald, We actually need this workflow to run on the following condition",
      "customerName" : "Owen Freheim",
      "modifiedAt" : "2017-09-12T11:22:11Z",
      "assignedid" : 0,
      "waitingSince" : "2017-09-12T11:22:11Z",
      "waitingSinceType" : 2,
      "tags" : [ {
        "id" : 1277761,
        "name" : "folder-refresh",
        "color" : "none"
      } ]
    }, {
      "id" : 430120638,
      "number" : 226333,
      "type" : "email",
      "mailboxid" : 85,
      "attachments" : true,
      "subject" : "Troubles with water level",
      "status" : "active",
      "threadCount" : 4,
      "preview" : "Hey there seems to be an issue with the following levels...",
      "customerName" : "Water service",
      "modifiedAt" : "2017-09-12T11:23:06Z",
      "assignedid" : 0,
      "waitingSince" : "2017-09-12T11:21:50Z",
      "waitingSinceType" : 2,
      "tags" : [ ]
    } ]
  }
}

Response fields

Path Type Description
conversations.pages Number The number of total available pages
conversations.page Number The current page
conversations.count Number The number of total conversations included in all pages
conversations.results Array Contains abbreviated versions of each conversation associated with the search criteria

Response fields

Path Type Description
id Number Unique identifier of the conversation
number Number The conversation number displayed in the UI. This number can be used in combination with the id to construct a URL to the conversation on the Help Scout website. Example: https://secure.helpscout.net/conversation/<id>/<number>/
type String The type of conversation; Accepted values are:
chat
email
phone
mailboxid Number Identifier of the mailbox in which this conversation resides
attachments Boolean attachments
subject String Conversation subject
status String Status of the conversation; Accepted values are:
active
closed
open
pending
spam
threadCount Number The number of published threads found on the conversation (does not include line items, drafts or threads held for review by Collision Detection)
preview String Preview of the most recent thread in the conversation
customerName String The customer who this conversation is associated with
customerEmail String The customer email address who this conversation is associated with
customerIds Array Identifiers of customer this conversation is associated with
modifiedAt String The date/time this conversation was last modified
assignedid Number The identifier of the user assigned to this conversation
assignedName String The name of the User assigned to this conversation
tags Array Collection of tags with each element containing the tag identifier, name, and color
↑Back to top
© Help Scout 2024