Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions docs/integration/reports-orig.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,42 +41,49 @@ The **Interaction Metadata** API is used to reconstruct the complete "story" of

A user would use this to perform forensic tracking or quality assurance. For example, if a customer was transferred three times, this API provides the metadata for all three segments, including specific timestamps for when each agent joined or left, and the direct URL to the audio recording for that specific portion of the call.

* **Reference:** [Interaction Metadata API Details](https://developers.ringcentral.com/engage/voice/api-reference/Integration-Report-Controller/streamFileInteractionMetadata)
* **Reference:** [Interaction Metadata API Details](https://developers.ringcentral.com/engage/voice/api-reference/Public-Integration-API/getInteractionMetadata)

### Retrieving Agent Segment Recordings & Transcripts

Once metadata is retrieved, users can access the specific media files.

* **Recordings:** Used for compliance archiving and quality evaluations. To account for processing time, allow at least 10 minutes after an interaction completes before retrieval.
* **Transcripts:** Used for text-based sentiment analysis and quick review of conversations without listening to audio. Like recordings, these should be accessed after the 10-15 minute processing window.

For more details on how to retrieve these files refer to the [Call Transcripts API](../analytics/reports/call-transcripts.md)

---

## Aggregated Statistics

### Queue Statistics (`aggQueueStats`)
### Queue Statistics (`agg-queue-stats`)

**Purpose:** Service Level Monitoring and Operational Health.

The **Queue Statistics** API provides a high-level view of how specific contact center queues are performing over defined time intervals (15, 30, 45, or 60 minutes). It aggregates data across the entire queue rather than focusing on individual agents.

Operations managers use this data to ensure the center is meeting its Service Level Agreements (SLAs). It is the primary tool for identifying volume trends, such as spikes in abandoned calls or excessive wait times, allowing for real-time or historical staffing adjustments.

* **Reference:** [Queue Statistics API Details](https://developers.ringcentral.com/engage/voice/api-reference/Integration-Report-Controller/streamFileAggQueueStats)
* **Reference:** [Queue Statistics API Details](https://developers.ringcentral.com/engage/voice/api-reference/Public-Integration-API/buildAggQueueStats)

### Agent Statistics (`aggAgentStats`)
### Agent Statistics (`agg-agent-stats`)

**Purpose:** Workforce Productivity and Attendance Tracking.

The **Agent Statistics** API is designed to measure the general output and availability of the workforce. It focuses on how agents are spending their time across broad categories like "talking," "wrap-up," or "idle".

A user would use this API to generate daily or weekly productivity reports. It is commonly used for payroll verification and ensuring that agents are adhering to their scheduled shifts by comparing their active time against their expected hours.

* **Reference:** [Agent Statistics API Details](https://developers.ringcentral.com/engage/voice/api-reference/Integration-Report-Controller/streamFileAggAgentStats)
* **Reference:** [Agent Statistics API Details](https://developers.ringcentral.com/engage/voice/api-reference/Public-Integration-API/buildAggAgentStats)

### Agent Extended Statistics (`aggAgentExtendedStats`)
### Agent Extended Statistics (`agg-agent-extended-stats`)

**Purpose:** Deep-Dive Performance and Behavioral Analysis.

The **Agent Extended Statistics** API provides a more granular breakdown of performance metrics for agents across their assigned queues. It builds upon basic stats by adding specific handling details, such as transfer counts and precise handling times per queue.

This is the preferred tool for workforce planners and supervisors performing root-cause analysis. If a supervisor notices a drop in efficiency, they can use this API to determine if the issue is tied to a specific queue or if an agent is transferring a disproportionate number of interactions, indicating a potential need for further training.

* **Reference:** [Agent Extended Statistics API Details](https://developers.ringcentral.com/engage/voice/api-reference/Integration-Report-Controller/streamFileAggAgentExtendedStats)
* **Reference:** [Agent Extended Statistics API Details](https://developers.ringcentral.com/engage/voice/api-reference/Public-Integration-API/buildExtendedAggAgentStats)

---
Loading