RingCentral Business Analytics API
The Business Analytics API from RingCentral — 2 operation(s) for business analytics.
RingCentral Business Analytics API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Business Analytics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 2 operations across 2 paths, and defines 73 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.
Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.
2 operations
2 paths
73 schemas
2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
RingCentral Business Analytics API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow.
By default, every request must be authenticated.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.
Business Analytics 2
POST
/analytics/calls/v1/accounts/{accountId}/aggregation/fetch
Calls Aggregation Data
POST
/analytics/calls/v1/accounts/{accountId}/timeline/fetch
Calls Timeline Data
Schemas 73
The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are CallFilters (14 properties), TimelineResponseOptionsCounters (11 properties), CallsCounters (11 properties), AggregationResponseOptionsCounters (11 properties). Each schema is shown below with its type and property counts.
CallsByOriginBreakdown
object
Result breakdown by origin
2 properties
2 required
ApiError
object
Generalized API error structure suitable for any error type
2 properties
2 required
AggregationRequest
object
4 properties
3 required
CallDurationFilter
object
Filtering of calls based on the overall call length
2 properties
AggregationResponseOptionsTimers
object
The formula is defined by aggregationType and aggregationInterval for every timer individually. If aggregationType is Sum or Percent, aggregationInterval is no…
9 properties
TimelineResponseData
object
A list of time-value points of call data as per the grouping and filtering options specified in the request
2 properties
1 required
CallResult
string
CallsByQueueSla
object
Data for calls with breakdown by queue SLA (InSLA, OutSLA). This counter is only applicable to Queues grouping
2 properties
2 required
CallsByResponseBreakdown
object
Result breakdown by response
4 properties
4 required
AggregationInterval
string
Time interval which will be used for aggregation. Can be Hour, Day, Week or Month
CallsByDirectionBreakdown
object
Result breakdown by direction
2 properties
2 required
ValueType
string
Unit of the result value
TimelineResponse
object
2 properties
2 required
TimelineResponseOptionsCounters
object
Options for selecting breakdown for calls count
11 properties
CallsByCompanyHours
object
Data for calls with breakdown by company hours (BusinessHours, AfterHours)
2 properties
2 required
Grouping
This field specifies the dimensions by which the response should be grouped and specific keys to narrow the response. See also [Call Aggregate reports](https:/…
CallsByType
object
Data for calls with breakdown by type (Direct, FromQueue, ParkRetrieval, Transferred, Outbound, Overflow)
2 properties
2 required
TimeSpentFilter
object
Filtering of calls based on the time spent by specified mailbox(es) on call
2 properties
QueueOpportunitiesAggregationType
string
Counter aggregation type for queue opportunities, limited to Sum only.
CallsByDirection
object
Data for calls with breakdown by direction (Inbound, Outbound)
2 properties
2 required
CallsByOrigin
object
Data for calls with breakdown by origin (Internal, External)
2 properties
2 required
ExtensionFilters
object
Specifies filtering based on extension ids
2 properties
AggregationResponse
object
2 properties
2 required
TimelineRequest
object
4 properties
3 required
MembersGroupingOptions
string
The selected data scope
CallsTimers
object
Call length data for the specified grouping
9 properties
TimeRange
object
Time range for the request
2 properties
2 required
TimelineResponseOptions
object
Counters and timers options for calls breakdown
2 properties
TimeSettings
object
Date-time range for the calls. The call is considered to be within time range if it started within time range. Both borders are inclusive
3 properties
2 required
CallsBySegmentsBreakdown
object
Result breakdown by segments
9 properties
9 required
Interval
string
CallAction
string
CallsByCompanyHoursBreakdown
object
Result breakdown by company hours
2 properties
2 required
CallsByResultBreakdown
object
Result breakdown by call result
6 properties
6 required
DirectGrouping
object
This grouping allows to specify the groupBy option by which the data in the response will be grouped
2 properties
1 required
CallsBySegments
object
Data for calls with breakdown by segments (Ringing, LiveTalk, Hold, Park, Transfer, IvrPrompt, Voicemail, VmGreeting, Setup)
2 properties
2 required
CallsByActions
object
Data for calls with breakdown by action (HoldOff, HoldOn, ParkOn, ParkOff, BlindTransfer, WarmTransfer, DTMFTransfer)
2 properties
2 required
CallsCounters
object
Call volume data for the specified grouping
11 properties
CallsByTypeBreakdown
object
Result breakdown by type
6 properties
6 required
CallsByQueueSlaBreakdown
object
Result breakdown by queue SLA
2 properties
2 required
CallSegmentLengthFilter
object
Duration bounds for the segment
2 properties
TimelineResponsePoint
object
3 properties
1 required
AggregationType
string
Counter aggregation type. Can be Sum, Average, Min, Max or Percent
CallSegmentOptions
string
Call segment for filtering
Direction
string
CallType
string
KeyInfo
object
Additional info about the key
2 properties
ResponsePaging
object
Paging information
4 properties
4 required
AggregationResponseOptionsCounters
object
The formula is defined by aggregationType and aggregationInterval for every counter individually. If aggregationType is Sum or Percent, aggregationInterval is…
11 properties
TimelineResponseOptionsTimers
object
Options for selecting breakdown for calls duration
9 properties
CallsByActionsBreakdown
object
Result breakdown by actions
7 properties
7 required
AllCalls
object
Data for all calls
2 properties
2 required
AdvancedTimeSettings
object
Allows more granular control over time included in the report
2 properties
CallSegmentFilter
object
2 properties
1 required
CallsByResponse
object
Data for calls with breakdown by response (Answered, NotAnswered, Connected, NotConnected)
2 properties
2 required
GroupingByMembers
object
This grouping allows to specify the groupByMembers option. The response data will be grouped by users and will only include users that belong to the scope sele…
2 properties
1 required
CompanyHoursOptions
string
QueueOpportunities
object
Queue opportunities data for the specified grouping
2 properties
2 required
ApiErrorWithParameter
The error model with additional attributes which can be used for HTTP 400/409 This is a deprecated model: "ApiError" model can be used instead with arbitrary a…
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property
1 required
HoursInterval
object
2 properties
2 required
GroupingOptions
string
The selected grouping option
AggregationResponseOptions
object
This field provides mapping of possible breakdown options for call aggregation and aggregation formula
2 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property
1 required
CallResponse
string
AggregationResponseData
object
Aggregation result
2 properties
1 required
AggregationResponseRecord
object
4 properties
1 required
QueueSlaOptions
string
CallFilters
object
Optional filters that limit the scope of calls (joined via AND)
14 properties
DayOfWeek
string
CallsByResult
object
Data for calls with breakdown by result (Completed, Abandoned, Voicemail, Unknown, Missed, Accepted)
2 properties
2 required
Origin
string
TimelineResponseRecord
object
3 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from RingCentral 12
Other APIs RingCentral publishes across the network.
RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API
#Business Analytics