Conversations - Received Messages Statistics

The received messages report provides a summary of the volume of received messages over a given time range. Only messages from customers are counted.

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

Request

GET /v2/reports/conversations/received-messages 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
previousStart date previousStart=2019-04-02T12:00:00Z
 Start of the previous interval
previousEnd date previousEnd=2019-05-02T12:00:00Z
 End of the previous interval
mailboxes number mailboxes=123
mailboxes=123,567
 List of comma separated ids to filter on inboxes
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
viewBy enumeration viewBy=day
 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

{
  "current" : [ {
    "start" : "2015-01-01T00:00:00Z",
    "count" : 29
  }, {
    "start" : "2015-01-08T00:00:00Z",
    "count" : 28
  }, {
    "start" : "2015-01-15T00:00:00Z",
    "count" : 24
  }, {
    "start" : "2015-01-22T00:00:00Z",
    "count" : 14
  }, {
    "start" : "2015-01-29T00:00:00Z",
    "count" : 9
  } ],
  "previous" : [ {
    "start" : "2014-01-01T00:00:00Z",
    "count" : 3
  }, {
    "start" : "2014-01-08T00:00:00Z",
    "count" : 15
  }, {
    "start" : "2014-01-15T00:00:00Z",
    "count" : 577
  }, {
    "start" : "2014-01-22T00:00:00Z",
    "count" : 9
  }, {
    "start" : "2014-01-29T00:00:00Z",
    "count" : 20
  } ]
}

Response fields

Path Type Description
current Array Contains the volume of received messages statistics for each day/hour of the week for the current time range
previous Array Contains the volume of received messages statistics for each day/hour of the week for the previous time range; only included if a previous time range was specified

Response fields

Path Type Description
.start String Start of the interval
.count Number Number of received messages from start until the next time interval (one of either day, week, or month, as specified in the request)
↑Back to top
© Help Scout 2024