get_analytics
Retrieve detailed analytics from the Kaltura Report API. Generate reports on content performance, user engagement, geographic distribution, platform usage, and more. Specify dates, entry ID, report type, and metrics for tailored insights.
Instructions
Get comprehensive analytics using Kaltura Report API. Supports multiple report types including content performance, user engagement, geographic distribution, contributor stats, and more.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
categories | No | Optional category filter (use full category name including parent paths) | |
entry_id | No | Optional media entry ID for specific entry analytics. If omitted, returns aggregated analytics. | |
from_date | Yes | Start date for analytics (YYYY-MM-DD format) | |
limit | No | Maximum number of results to return (default: 20, max: 100) | |
metrics | No | Metrics to retrieve: plays, views, engagement, drop_off. Used for reference/interpretation. | |
report_type | No | Type of analytics report. Key options include: 'content' (top content), 'content_dropoff' (viewer retention), 'engagement_timeline' (timeline heatmap showing most watched/replayed segments), 'user_engagement' (user behavior), 'geographic_*' (location analytics), 'platforms/browsers/operating_system' (technology stats), 'playback_rate' (speed preferences), 'player_interactions' (control usage). See docs for full list. Default: 'content' | |
to_date | Yes | End date for analytics (YYYY-MM-DD format) |