Skip to main content
View as Markdown

Overview - Analytics

Analytics Reports API​

Pull analytics data out of Kaltura — content performance, viewer engagement, event attendance, and operational metrics. Multiple report surfaces exist (API v3 report service, Reports Microservice, live reports, stream health beacons) and this guide unifies them into a single reference.

Base URL: https://www.kaltura.com/api_v3 (report, liveReports, stats, beacon services) Auth: KS passed as ks parameter in POST form data Format: Form-encoded POST, format=1 for JSON responses

Services covered:

ServiceActionsDescription
report7 actionsHistorical analytics — tables, totals, graphs, CSV export
Reports Microservice2 endpointsAsync report generation for C&C, registration, enrichment
liveReportsgetEventsReal-time live stream analytics
statscollectServer-side statistics collection
beaconlistStream health diagnostics and encoder data

When to Use​

  • Executive dashboards surfacing content performance, viewer engagement, and platform usage at a glance
  • Content strategists measuring play counts, watch-through rates, and drop-off points to optimize video libraries
  • Event organizers tracking attendance, session participation, and engagement scores for virtual events
  • Compliance and billing teams generating usage reports for license audits, SLA verification, or chargeback models
  • BI and data engineering teams exporting analytics data into external warehouses or visualization tools

Prerequisites​

  • KS type: ADMIN KS (type=2) with the ANALYTICS_BASE permission (role permission ID 1085)
  • Plugins: No additional plugins required for the report service; Reports Microservice requires Bearer token auth
  • Session guide: Generate a KS using session.start or appToken.startSession (see Session Guide)

Authentication​

All report service calls use the standard API v3 pattern with a KS. Reports Microservice calls use Bearer token auth.

# Set up environment
export KALTURA_SERVICE_URL="https://www.kaltura.com/api_v3"
export KALTURA_REPORTS_URL="https://reports.nvp1.ovp.kaltura.com"
export KALTURA_KS="your_kaltura_session"
export KALTURA_PARTNER_ID="your_partner_id"

Generate an ADMIN KS (type=2) via session.start (see Session Guide) or appToken.startSession (see AppTokens Guide).

Analytics access requires the ANALYTICS_BASE permission (ID 1085) on the KS role. See Error Handling & Permissions for the full permissions table.