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.

Request

GET /v2/reports/conversations/received-messages 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" : [ {
    "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

New Conversation Statistics

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)