TwentyThree Developer APIAPI Method: /api/analytics/report/event

API Method: /api/analytics/report/event

Last updated on July 26, 2013.

Report an event back to the analytics engine.

The reporting methods are used to report additional contextual information about a playback session, but is not the exclusive source for data. This is why any reporting request must originate from the session that is handling the play. For example, if you have requested a list of videos and started playing one, your actions and playback have already been tracked. However, reporting back a playback or an event with allow futher information to be tracked.

Parameters

ParameterDescription
photo_id (required)The ID of the playing video.
event (required)The event identifier (see below).
user_player_typeThe type of player used by the client (should be flash or html5).
user_player_versionThe version of player used by the client.
user_player_resolutionThe resolution of the client's screen.
source A source for the request, designed to be used in analytics (normal options are admin, site, share, embed, podcast, download, search and facebook but you may choose your own source).

Event types

Currently, the following event identifiers are supported:

  • load: the player has been loaded
  • fullscreen: fullscreen view has been toggled
  • preRollClose: the user actively closed the pre-roll
  • preRollClick: the user clicked the pre-roll
  • postRollClose: the user actively closed the post-roll
  • postRollClick: the user clicked the post-roll
  • callToActionClick: the user clicked a "call to action" element
  • embedEngaged: the user requested the embed code
  • shareEngaged: the user requested the sharing options

Permission level

The minimum required permission level is:

none

Example XML Response

<response status="ok" permission_level="anonymous" 
  message="The event was reported" cached="0"/>

Example JSON Response

{
  "status": "ok", 
  "message":"The event was reported",
  "permission_level":"anonymous",
  "cached":"0",
  "report":{},
  "p": "1",
  "size": "1",
  "site": { ... },
  "endpoint": "/api/analytics/report/play"
}