timeZonestringrequired*— IANA time zone name applied to `advancedTimeSettings` and aggregation intervals, e.g. 'America/Los_Angeles', 'US/Pacific'. Does not shift `timeRange`, which already carries its own UTC offset.
timeRangeobjectrequired*— The report's date-time window.
timeFromstringrequired*— Start of the report window, RFC 3339 date-time (inclusive), e.g. '2026-08-03T00:00:00.000Z'.
timeTostringrequired*— End of the report window, RFC 3339 date-time (inclusive). Must not be in the future — RingCentral rejects a future `timeTo` with 400 ANL-302.
advancedTimeSettingsobject— Optional finer-grained day/hour filters layered on top of `timeRange`.
includeDaysarray— Restrict the report to these days of the week only.
1 field
[]string(enum: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday")
includeHoursarray— Restrict the report to these clock-time windows only.
1 field
[]object
2 fields
fromstringrequired*— Start of the interval, `hh:mm` (inclusive).
tostringrequired*— End of the interval, `hh:mm` (inclusive).
extensionFiltersobject— Narrow by the extensions that received/placed the call.
fromIdsarray— Match calls incoming to any of these extension ids (OR).
1 field
[]string
toIdsarray— Match calls outgoing to any of these extension ids (OR).
1 field
[]string
queuesarray— Only calls routed through one of these queue extension ids.
calledNumbersarray— Only calls to one of these direct company numbers.
directionsarray— Only calls in one of these directions.
[]string(enum: "Inbound", "Outbound")
originsarray— Only calls whose initial segment had/lacked an external party.
[]string(enum: "Internal", "External")
callResponsesarray— Only calls with one of these first-response outcomes.
[]string(enum: "Answered", "NotAnswered", "Connected", "NotConnected")
callResultsarray— Only calls with one of these overall results.
[]string(enum: "Completed", "Abandoned", "Voicemail", "Unknown", "Missed", "Accepted")
callSegmentsarray— Only calls that contain one of these segments.
[]object
2 fields
segmentstringrequired*— The call segment that must be present.(enum: "Ringing", "LiveTalk", "Hold", "Park", "Transfer", "IvrPrompt", "Voicemail", "VmGreeting", "Setup")
lengthobject— Optional duration bound on that segment.
2 fields
minSecondsinteger— Lower bound, in seconds (inclusive).
maxSecondsinteger— Upper bound, in seconds (inclusive).
callActionsarray— Only calls that contain one of these actions.
[]string(enum: "HoldOff", "HoldOn", "ParkOn", "ParkOff", "BlindTransfer", "WarmTransfer", "DTMFTransfer")
companyHoursarray— Only calls placed inside/outside company business hours.
[]string(enum: "BusinessHours", "AfterHours")
callDurationobject— Only calls within this total-length range.
minSecondsinteger— Lower bound, in seconds (inclusive).
maxSecondsinteger— Upper bound, in seconds (inclusive).
timeSpentobject— Only calls where the specified mailbox(es) spent this much time on the call.
minSecondsinteger— Lower bound, in seconds (inclusive).
maxSecondsinteger— Upper bound, in seconds (inclusive).
queueSlaarray— Only queue calls that were in/out of SLA (Queues grouping only).
[]string(enum: "InSla", "OutSla")
callTypesarray— Only calls of one of these types.
[]string(enum: "Direct", "FromQueue", "ParkRetrieval", "Transferred", "Outbound", "Overflow")
countersobject— Call-count time-series to include.
allCallsboolean— Include the total call count per time point.
callsByDirectionboolean— Include call count by direction per time point.
callsByOriginboolean— Include call count by origin per time point.
callsByResponseboolean— Include call count by first response per time point.
callsSegmentsboolean— Include call count by segment per time point.
callsByResultboolean— Include call count by result per time point.
callsByCompanyHoursboolean— Include call count by company hours per time point.
callsByQueueSlaboolean— Include call count by queue SLA per time point (Queues grouping only).
callsByActionsboolean— Include call count by action per time point.
callsByTypeboolean— Include call count by type per time point.
queueOpportunitiesboolean— Include queue-opportunity count per time point. Limited to `Users`/member (Department, Queue, Site, UserGroup) grouping.
timersobject— Call-duration time-series to include.
allCallsDurationboolean— Include total call duration per time point.
callsDurationByDirectionboolean— Include call duration by direction per time point.
callsDurationByOriginboolean— Include call duration by origin per time point.
callsDurationByResponseboolean— Include call duration by first response per time point.
callsSegmentsDurationboolean— Include call duration by segment per time point.
callsDurationByResultboolean— Include call duration by result per time point.
callsDurationByCompanyHoursboolean— Include call duration by company hours per time point.
callsDurationByQueueSlaboolean— Include call duration by queue SLA per time point (Queues grouping only).
callsDurationByTypeboolean— Include call duration by type per time point.