Report
Get report data
GET /report/{reportCode}
GET /report/{reportCode}
Returns the data for a specific report type
Path parameters
reportCodeenumpathrequiredThe type of report to retrieve
Query parameters
statusstringqueryFilter by status. Supported values depend on the report type:
- channelMix: open, closed, pending (ticket status)
- telephonyAgents: all, assignedToPhone, online, onlineActive (user status categories)
channelenumqueryFilter by channel (only for channelMix report)
lastDaysenumqueryNumber of days to look back (for solvedTicketsByTeam, solvedTicketsByResolution, incomingVolume, channelMix, telephonyPerformance, telephonyCallInsights, telephonyLineTopPerformers, and other telephony reports)
agentenumqueryFilter by agent type (only for solvedTicketsByResolution, solvedTicketsByTeam, customerSurveys report)
ticketScopeenumqueryRestrict the report to tickets matching the agent's configured skill tags (only for openTickets, channelMix, solvedTicketsByTeam, customerSurveys reports).
- all: no skill-based restriction
- skills: restrict to tickets whose routing-relevant tags overlap the agent's
actualSkills.tagIdsWhen the agent has no skill tags configured,skillsbehaves likeall.
teamIdsstringqueryFilter by teams (only for telephonyAgents report). Can be 'all' or comma-separated team IDs.
lineIdsstringqueryFilter by telephony lines (for telephonyAgents and telephonyAiAgents reports). Can be 'all' or comma-separated line IDs.
showenumqueryFilter by user type (only for telephonyAgents report). Defaults to 'users' if not provided.
qstringquerySearch by agent name (case-insensitive substring, only for telephonyAgents report).
limitintegerqueryMaximum number of items to return (only for telephonyAgents report). Defaults to 1000.
offsetintegerqueryNumber of items to skip for pagination (only for telephonyAgents report). Defaults to 0.
lineIdstringqueryFilter by specific telephony line ID (for telephonyPerformance, telephonyCallInsights, telephonyLineTopPerformers reports). Required for telephonyLineTopPerformers.
agentsTypeenumqueryFilter by agent type (only for telephonyLineTopPerformers report). Defaults to 'all' if not provided.
scorecardIdstringqueryFilter by scorecard base ID (only for qualityAssessments report).
assessedUserIdstringqueryRestrict the report to a single assessed user (only for qualityAssessments report).
Overrides the agent scope. The requested user must be within the caller's permitted
audience (own < team < all) or a 403 is returned.
assessedTeamIdstringqueryRestrict the report to the current members of a single team (only for qualityAssessments report).
Overrides the agent scope; ignored when assessedUserId is also set. The team must be within
the caller's permitted audience (ViewAll → any team; ViewTeam → own teams) or a 403 is returned.
Filters by current team membership, not the historical team snapshot shown in teamBreakdown.
dateFromstringqueryStart date for custom date range (only for qualityAssessments report, overrides lastDays). Format: YYYY-MM-DD
dateTostringqueryEnd date for custom date range (only for qualityAssessments report, overrides lastDays). Format: YYYY-MM-DD
granularityenumqueryTime bucket size for time-series reports. When omitted the response is byte-identical to the pre-granularity behaviour (including the legacy 0–23 hour-of-day profile for callsAnsweredByHour). Applicable reports — hour/day/week/month: incomingVolume, telephonyPerformance, telephonyCallInsights (aiHandledVsHuman + callsAnsweredByHour timeline), telephonyAgentPerformance, telephonyAiAgentPerformance, telephonyAiAgentCallInsights. Day/week/month only (DATE column, no time-of-day): solvedTicketsByTeam, solvedTicketsByResolution.
- hour: one bucket per clock-hour, keys in "YYYY-MM-DD HH:00" format; only allowed with lastDays ≤ 31
- day: one bucket per calendar day, keys in dd.mm format (legacy default)
- week: one bucket per ISO week, keys in YYYY-WNN format
- month: one bucket per calendar month, keys in YYYY-MM format
Responses
200 — Successful operation
Response Example
{
"data": null,
"description": "Tickets in status 'open', broken down by due date compared to the current time.",
"summary": null,
"total": 42,
"filters": {
"lastDays": 14,
"agent": "own"
}
}400 — Invalid filter parameters
403 — Unauthorized
500 — Internal error