API Method: /api/analytics/report/play

Report a video download or stream event back to the analytics engine.

This method should be called after the download or stream has concluded and include the total number of bytes transfered along with a session_id from TwentyThree. This might retrieved either from a cookie or is included in the requesting URL as a GET parameter named session_id. If session_id is provided, photo_id is too.

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.
seesion_id (required if not in cookie)The ID of the playing video.
bytes_total (required)The total bytes transfered during the stream or download..
skipIndicated whether this download or stream session was the result of the user scrubbing an existing playback session rather than starting a new one. Valid values are 0 and 1.
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

This method is only available from whitelisted servers. After whitelisting, a server may call the method on specifically allowed domains and do so anonymously.

Example XML Response

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

Example JSON Response

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