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

API Method: /api/analytics/report/play

Last updated on June 3, 2013.

Report a playback event back to the analytics engine.

This method should be called both when starting and stopping playback.

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.
timeStart (required)The start time in seconds of the current playback.
timeEndThe end time in seconds of the current playback.
timeTotalThe total time in seconds of the video currently paying.
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.

Permission level

The minimum required permission level is:

none

Example XML Response

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

Example JSON Response

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