Enneo

Report

Get report data

GET /report/{reportCode}

GET /report/{reportCode}

Returns the data for a specific report type

Path parameters

reportCodeenumpathrequired

The type of report to retrieve

Query parameters

statusstringquery

Filter by status. Supported values depend on the report type:

  • channelMix: open, closed, pending (ticket status)
  • telephonyAgents: all, assignedToPhone, online, onlineActive (user status categories)
channelenumquery

Filter by channel (only for channelMix report)

lastDaysenumquery

Number of days to look back (for solvedTicketsByTeam, solvedTicketsByResolution, incomingVolume, channelMix, telephonyPerformance, telephonyCallInsights, telephonyLineTopPerformers, and other telephony reports)

agentenumquery

Filter by agent type (only for solvedTicketsByResolution, solvedTicketsByTeam, customerSurveys report)

ticketScopeenumquery

Restrict 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.tagIds When the agent has no skill tags configured, skills behaves like all.
teamIdsstringquery

Filter by teams (only for telephonyAgents report). Can be 'all' or comma-separated team IDs.

lineIdsstringquery

Filter by telephony lines (for telephonyAgents and telephonyAiAgents reports). Can be 'all' or comma-separated line IDs.

showenumquery

Filter by user type (only for telephonyAgents report). Defaults to 'users' if not provided.

qstringquery

Search by agent name (case-insensitive substring, only for telephonyAgents report).

limitintegerquery

Maximum number of items to return (only for telephonyAgents report). Defaults to 1000.

offsetintegerquery

Number of items to skip for pagination (only for telephonyAgents report). Defaults to 0.

lineIdstringquery

Filter by specific telephony line ID (for telephonyPerformance, telephonyCallInsights, telephonyLineTopPerformers reports). Required for telephonyLineTopPerformers.

agentsTypeenumquery

Filter by agent type (only for telephonyLineTopPerformers report). Defaults to 'all' if not provided.

scorecardIdstringquery

Filter by scorecard base ID (only for qualityAssessments report).

assessedUserIdstringquery

Restrict 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.

assessedTeamIdstringquery

Restrict 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.

dateFromstringquery

Start date for custom date range (only for qualityAssessments report, overrides lastDays). Format: YYYY-MM-DD

dateTostringquery

End date for custom date range (only for qualityAssessments report, overrides lastDays). Format: YYYY-MM-DD

granularityenumquery

Time 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