Inbox
Shared inbox helpdesk for all your support channels. Built for your team.
Chat
Live chat with automated messaging, chatbots, and video calls for your website or web app.
Chatbots
Automate every business opportunity with pre-built and custom chatbots.
Push Campaigns
Increase re-engagement and boost sales with targeted push notification campaigns.
AI BETA
Leverage the power of AI to help you respond, create, and summarize.
FAQ
Customizable and embeddable FAQ center to help customers help themselves.
Status Page
Keep customers informed by alerting them when there’s an incident or outage.
Live
Get more sales with real time customer activity monitoring and personal messages.

Show Developer Menu

GET /reports/channel_summary

Returns a channel report summarizing channel metrics. By default, returns data for all brands in your account. Use the brand parameter to filter to a specific brand.

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
  • brand - Filter by brand URL (e.g., mybrand). Without this parameter, returns data for all brands in your account
  • start_date - Choose the start of the report (defaults to 30 days ago)
  • end_date - Choose the end of the report (defaults to today)

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.