Metrics and Analytics
Overview of the metrics and analytics endpoint collection.
Overview of Metrics & Analytics
The Metrics & Analytics category in the R1 Discover API provides a suite of endpoints designed to deliver actionable insights into video engagement and user interactions. These endpoints enable you to access detailed metrics such as playback data, viewing durations, watched percentages, and other key performance indicators at both company and individual user levels. This category is essential for optimizing content delivery, enhancing user experiences, and making data-informed decisions to improve your digital offerings.
Endpoints in This Category
The Metrics & Analytics collection includes the following endpoints:
List Company Video Metrics Retrieve aggregated video metrics for a specific company, including video log IDs, video URLs, titles, start and completion timestamps, watched percentages, and durations.
List User Video Metrics Fetch detailed video interaction data for a specific user, allowing you to monitor individual engagement trends and performance indicators.
Use Cases
Metrics & Analytics endpoints are typically used to:
Optimize Content Performance – Evaluate metrics such as watched duration and completion rates to refine video content and delivery strategies.
Inform Data-Driven Decisions – Combine video metrics with other data sources (e.g., activity and user results) to gain a holistic view of program effectiveness.
Support Reporting – Generate comprehensive reports on content performance to share insights with stakeholders and inform strategic planning.
Best Practices
Authentication: Always include a valid Bearer token in the Authorization header to ensure secure access.
Pagination: Use pagination parameters (page and limit) to efficiently handle large datasets and maintain optimal performance.
Error Handling: Prepare for common errors such as 401 Unauthenticated or 403 Unauthorized by verifying token validity and permissions.
Data Context: When interpreting metrics, consider factors such as video length, audience segmentation, and contextual differences across campaigns.
Integration Points
To maximize the utility of the Metrics & Analytics endpoints, consider these integration strategies:
Dashboard Integration: Incorporate video metrics into your analytics dashboard for real-time performance monitoring.
Content Management Systems: Use the insights provided to fine-tune your video content and delivery strategies.
Cross-Category Reporting: Merge video metrics with data from other categories (e.g., Activity Results) to develop comprehensive reports on user engagement and program success.
Additional Resources
Postman Collection: Access the full R1 Discover API Postman collection for pre-built requests and additional examples.
Support: For further assistance, contact the R1 Discover API support team at [email protected].
Changelog: Stay informed on the latest API updates by reviewing the API Changelog.
Last updated