Analytics API

Edit online

Tap into the engagement and telemetry data of IBM Video Streaming. Create filters for live and VOD (video-on-demand) un-sampled data and get a customized data feed for further processing.

Overview

The Analytics API provides comprehensive access to viewer engagement and streaming telemetry data, enabling you to:

  • Access detailed viewer analytics and engagement metrics
  • Create custom reports and dashboards
  • Filter and segment data by various dimensions
  • Export data for external analysis and processing
  • Monitor live stream performance in real-time
  • Analyze video-on-demand viewing patterns

Key Features

Un-sampled Data
Access complete, un-sampled data sets for accurate analysis and reporting without statistical approximations.
Real-time Analytics
Monitor live stream performance with real-time viewer counts, engagement metrics, and quality indicators.
Historical Data
Query historical viewing data to identify trends, patterns, and insights over time.
Custom Filters
Create sophisticated filters to segment data by geography, device type, viewer behavior, and custom dimensions.
Data Export
Export analytics data in various formats for integration with business intelligence tools and data warehouses.

Available Metrics

The Analytics API provides access to a wide range of metrics:

  • Viewer Metrics: Unique viewers, concurrent viewers, total views, view duration
  • Engagement Metrics: Average watch time, completion rate, interaction events
  • Quality Metrics: Buffering ratio, startup time, bitrate distribution
  • Geographic Data: Viewer locations by country, region, and city
  • Device Data: Device types, operating systems, browsers
  • Traffic Sources: Referrers, embedded locations, direct access

Data Dimensions

Analytics data can be segmented and filtered by multiple dimensions:

Dimension Description
Time Filter by date ranges, hours, or custom time periods
Content Analyze specific channels, videos, or content categories
Geography Segment by country, region, city, or custom geographic areas
Device Filter by device type, OS, browser, or screen size
Viewer Analyze authenticated viewer behavior and preferences

API Endpoints

The Analytics API provides RESTful endpoints for accessing data:

  • GET /analytics/viewers - Retrieve viewer statistics
  • GET /analytics/engagement - Get engagement metrics
  • GET /analytics/quality - Access quality metrics
  • GET /analytics/geography - Get geographic distribution
  • GET /analytics/devices - Retrieve device statistics

Data Formats

Analytics data can be retrieved in multiple formats:

  • JSON: Standard format for API responses and programmatic access
  • CSV: Comma-separated values for spreadsheet applications
  • XML: Structured data format for enterprise integrations

Common Use Cases

  • Building custom analytics dashboards
  • Integrating with business intelligence platforms
  • Monitoring content performance and ROI
  • Optimizing content strategy based on viewer behavior
  • Generating automated reports and alerts
  • Analyzing audience demographics and preferences

Rate Limits and Best Practices

To ensure optimal performance:

  • Respect API rate limits to avoid throttling
  • Use appropriate date ranges to limit data volume
  • Cache frequently accessed data when possible
  • Implement pagination for large data sets
  • Schedule bulk exports during off-peak hours