Show Developer Menu

GET /reports/channel_summary

Returns a channel report summarizing channel metrics

Example Request
curl 'https://{brand}.reamaze.io/api/v1/reports/channel_summary' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json'
Example Response
{
  "channels":
    {
      ...
      "12345":
        {
          "channel": {
            "id": 12345,
            "name": "Support (US)",
            "channel_type": 1,
            "channel_type_name": "Email"
          },
          "brand": {
            "id": "123",
            "name": "Reamaze US",
            "url": "reamaze-us"
          },
          "staff_responses": 15,
          "customer_responses": 10,
          "average_response_time_seconds": 90,
          "appreciations": 5,
          "active_conversations": 10,
          "resolved_conversations": 5,
          "archived_conversations": 1,
          "average_satisfaction_rating": 4.9,
          "average_thread_size": 2.6
        },
      ...
    },
  "start_date": "2017-07-01",
  "end_date": "2017-07-30"
}
Optional Params
  • The start_date value can used to choose the start of the report.
  • The end_date value can used to choose the end of the report.

The start and end dates of the report will default to the last 30 days. Time frames can be no smaller than 1 day and no larger than 1 year.