How can I send player usage events and see them on the Analytics tab

Printer-friendly version

Sending Events from a Player to Kaltura Analytics

You can send events from a player to Kaltura Analytics by passing a URL to stats.kaltura.com using the GET method with the following parameters.

Mandatory Parameters

  • uiConfID = "event:uiconfId"; numeric must
  • PartnerID = "event:partnerId"
  • entryID = "event:entryId"
  • sessionID = "event:sessionId"; unique generated id
  • duration = "event:duration" - entry duration
  • queryStringReferrer = "event:referrer" - embedded url
  • eventTimestamp = "event:eventTimestamp"

Event Types

The following is a list of all event types you can send to the Kaltura Analytics server, arranged by "event_type_id" and "event_type_name".

event_type_id event_type_name
1 Widget Loaded
2 Media Loaded (view)
3 Play
4 Play reached 25%
5 Play reached 50%
6 Play reached 75%
7 Play reached 100%
8 Open Edit
9 Open Viral
10 Open Download 
11 Open Report 
12 Buffer Start
13 Buffer End 
14 Open Full Screen
15 Close Full Screen
16 Replay 
17 Seek    
18 Open Upload 
19 Save & Publish 
20 Close Edtior 
21 Pre Bumper Played 
22 Post Bumper Played 
23 Bumper Clicked 
24 Preroll Started 
25 Midroll Started 
26 Postroll Started 
27 Overlay Started 
28 Preroll Clicked 
29 Midroll Clicked 
30 Postroll Clicked 
31 Overlay Clicked 
32 Preroll 25
33 Preroll 50
34 Preroll 75
35 Midroll 25
36 Midroll 50
37 Midroll 75
38 Postroll 25
39 Postroll 50
40

Postroll 75

Optional/Unknown:

  • uid = "event:userId"
  • clientVersion = "event:clientVer"; client version
  • widgetID = "event:widgetId";
  • uv = "event:uniqueViewer";
  • currentPoint = "event:currentPoint";
  • processDuration = "event:processDuration"
  • controlID = "event:controlId"
  • seekStringIndcator = "event:seek" 1 - true, 0 - false
  • newPoint = "event:newPoint"

Every key in must start with "event:" as the prefix, for example: event:partnerId=100.

Example URL:

http://stats.kaltura.com//api_v3/index.php?service=stats&action=collect&event%3AsessionId=BE9F3DA9%2D4CAD%2D09AA%2D69B2%2DD9627E509311&event%3AeventType=3&event%3AisFirstInSession=false&event%3ApartnerId=524241&event%3AentryId=1%5Ftly1gkdh&ignoreNull=1&event%3Areferrer=http%253A%2F%2Fwww%2Ekaltura%2Ecom%2Fdev%2F&event%3Aseek=false&event%3Aduration=75&event%3AuiconfId=48503&event%3AcurrentPoint=0&event%3AeventTimestamp=1317907399783&event%3AobjectType=KalturaStatsEvent&clientTag=kdp%3Av3%2E5%2E21%2Ccache%5Fst%3A20000000&event%3AclientVer=3%2E0%3Av3%2E5%2E21&ks=MjhmMDQ1OWZjODE3YWZlZGFjMTU4ODE1MjJhNTFmMjdjNTU2ZTFiMXw1MjQyNDE7NTI0MjQxOzEzMTc5OTMyODg7MDsxMzE3OTA2ODg4LjY1NDE7MDt2aWV3Oio7Ow%3D%3D

'%3' represents ':'

FAQ Type: 
(22329 reads)