Skip to main content
View as Markdown

Reference - Analytics

Error Handling & Permissions​

Analytics Permissions​

PermissionIDDescription
ANALYTICS_BASE1085Gate for all analytics views
FEATURE_NEW_ANALYTICS_TAB1125New analytics dashboard
FEATURE_LIVE_ANALYTICS_DASHBOARD1128Live analytics dashboard access
FEATURE_MULTI_ACCOUNT_ANALYTICS1130Multi-account (cross-account) analytics
FEATURE_LIVE_STREAM1104Required alongside ANALYTICS_BASE for live
FEATURE_END_USER_REPORTS1096End-user level reporting

Common Errors​

Error CodeCauseResolution
INVALID_KSExpired or malformed sessionGenerate a new KS
SERVICE_FORBIDDENKS role lacks ANALYTICS_BASEAssign analytics permissions to the role
REPORT_NOT_FOUNDInvalid reportType valueUse a valid integer ID from Report Types Reference
INVALID_PARAMSMissing required filter fieldsInclude fromDate and toDate at minimum

Reports Microservice Errors​

The Reports Microservice returns HTTP status codes. A report/serve call with statusOnly: true returns {"status": "pending"}, {"status": "in_progress"}, or {"status": "completed"}. If generation fails, the status response includes an error message.

  • Session Guide — appId:<name> KS privilege tags analytics per-application; userId ties analytics to a user
  • AppTokens — Scoped tokens for analytics-only access
  • Player Embed — Player v7 fires ~45 playback events that feed analytics automatically
  • Upload & Ingestion — baseEntry.exportToCsv for bulk content export
  • Webhooks — Trigger automated reporting on content events
  • Distribution — Distribution status tracking via analytics reports