Peak Hours

Retrieve message volume by hour of day (0–23) for your tenant over a look-back window — useful for spotting when chatter is busiest.

Use the optional days query parameter to control the aggregation window. Ideal for heatmap or bar charts that inform staffing, support hours, or campaign timing.

Use Peak Hours when:

• You need an hour-of-day distribution of message traffic.
• You want to decide support coverage or bot escalation windows based on real usage.
• You already load overview or activity elsewhere and only need to refresh the peak-hours chart.
• You prefer a lighter payload than Analytics Overview.

This endpoint requires tenant admin privileges with a valid client Access Token. End-user tokens are rejected. Hours are typically returned in UTC unless your deployment documents another timezone.

Each item in data.peakHours includes:

On success, the API returns hour buckets with message counts for the selected window.

{
  "success": true,
  "message": "Peak hours fetched successfully",
  "data": {
    "peakHours": [
      {
        "hour": 0,
        "count": 12
      },
      {
        "hour": 9,
        "count": 540
      },
      {
        "hour": 14,
        "count": 612
      },
      {
        "hour": 20,
        "count": 305
      }
    ]
  },
  "error": null
}

Peak Hours fails when the token is missing, expired, or lacks tenant admin privileges.

{
  "success": false,
  "message": "Access denied: tenant admin privileges required",
  "data": null,
  "error": null
}

{
  "success": false,
  "message": "No token, authorization denied",
  "data": null,
  "error": "Unauthorized"
}

• Fill missing hours with zero in your UI if the API omits quiet buckets, so the chart always spans 0–23.
• Document the timezone you display (UTC vs local) so admins interpret peaks correctly.
• Use a shorter days window (for example 7) when you care about recent schedule shifts.
• Always send tenant headers with a client Bearer token over HTTPS.