users > get_stats_for_content_type

Tutorials, technical documents and downloads

API: Reference

Rev. Jun. 7, 2018

Description

Get the statistics for an User regarding a particular content type (Clip, Channel, etc.). For example, if you want to get the list of Clips, Channels, etc. that a User viewed (with the corresponding statistics information)
It is the same type of statistics you can get from the WebTV Content Administrator (Users > Statistics Icon).

Requirements

Advanced User Management extension.
WS.WebTV 1.9+

Required Credential Permission

GET [Signed Requests Only]

Building the Request

Request URL and GET vars

GET vars specific to this request:

Var	Value	Description
go	users	The API section
do	get_stats_for_content_type	The API action
iq	*User ID*	The User ID.

Resulting Request URL:
The resulting request URL would be similar to this (don't forget to append the required info: key, timestamp, salt and signature):
https://....../api.php?go=users&do=get_stats_for_content_type&iq={user_id}&{required information}

POST vars

The following POST var is required.

Var	Value	Description
contentType	(string) *Content Type*	Possible values: "clip", "channel" (valid for video channels and pages), "gallery", "news", "event", "interactivity" (since WS.WebTV 3.0).

The following POST var is optional.

Var	Value	Description
getHeatmapURL	(int) *0/1*	[Only if contentType="clip"] Whether to include the URL of the heatmap image. NOTE: This variable is available since WS.WebTV 2.2.0.3.

Response Examples

If the request was successful, you'll receive a response containing:
• list: An array with the list of statistical information of the User, for the content type.

Example [User statistics for content type Clip] :

{
  "list": [
    {
      "id_clip": "1",
      "duration": "15",
      "is_ad": "0",
      "content_title": "Logo Presentation",
      "page_views": "22",
      "last_played_second": "0",
      "complete_playbacks": "4",
      "total_playbacks": "27",
      "total_play_time": "70",
      "heatmap": "998776622222100"
    },
    {
      "id_clip": "43",
      "duration": "9",
      "is_ad": "0",
      "content_title": "Channel Bumper",
      "page_views": "1",
      "last_played_second": "1",
      "complete_playbacks": "0",
      "total_playbacks": "14",
      "total_play_time": "1",
      "heatmap": "100000000"
    },
    {
      "id_clip": "9",
      "duration": "150",
      "is_ad": "0",
      "content_title": "Movie Trailer",
      "page_views": "2",
      "last_played_second": "0",
      "complete_playbacks": "0",
      "total_playbacks": "8",
      "total_play_time": "26",
      "heatmap": "311111111111111111111111000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
    },
    ...
  ]
}

If the request failed (for example, if no signature was provided in the request), you'll receive a response like the following:

{
    "error"      : "REQUEST_ERROR",
    "error_long" : "Missing signature"
}

Possible Error Messages
Besides the general errors, this request can return the following errors:

• REQUEST_ERROR | Invalid User ID:
User ID is not numeric or lower than 1.

• REQUEST_ERROR | Invalid Content Type [Must be 'clip', 'channel', 'news' or 'gallery']:
Unexpected value for contentType.

PHP Example Code

Preparing GET and POST data.

// The GET vars
$GET_VARS = array( 
                    "go"        => "users",
                    "do"        => "get_stats_for_content_type",
                    "iq"        => 3
                    );
 
// The POST vars
$POST_VARS = array(
                    "contentType"   => "clip"
                    );

Generating the salt, timestamp, signature and sending the request
*** The following code block is common to all signed requests ***

// Collect the API Base URL and Credential info
$API_URL = "https://www.mywebtvdomain.tv/api.php";
$API_KEY_ID = "1b323a1cb879fd4e66530fbad07a32ee"; 
$API_SHARED_SECRET = "MWIzMjNhMWNiODc5ZmQ0ZTY2NTMwZmJhZDA3YTMyZWViOTQ3MDJiOGM2ZTU2NjE3"; // keep this safe!!!
 
// Generating salt and timestamp
$salt = md5(mt_rand());
$timestamp = time();
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true));
 
// Generating the validation signature
// - Default method: using base64_encode(hash_hmac(...))
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true)); // comment this line if using the next method
// - Simplified method - available since v60: using md5(). 
//   This method requires the variable $API_SIGNATURE_GENERATION_MODE = 1; in the config/Config.inc.php file.
// $signature = md5($salt."-".$timestamp."-".$API_SHARED_SECRET); // you must "uncomment" this line when using the simplified method
 
// Append the timestamp, salt, key and signature to the GET vars
$GET_VARS["timestamp"] = $timestamp;    // UTC timestamp
$GET_VARS["salt"] = $salt;
$GET_VARS["key"] = $API_KEY_ID ;      // The API Key ID: This is public and is used by the API to identify the application;
$GET_VARS["signature"] = $signature;
 
// Create the request URL. Please note that if you do not use PHP buit in function 
// to create the HTTP query then don't forget to URL encode the values
$REQUEST_URL = $API_URL."?".http_build_query($GET_VARS); 
// The previous will build an URL like .../api.php?go=api_subject&do=api_action&etc...
 
// Create a new cURL resource and set the appropriate options
$ch = curl_init(); 
curl_setopt($ch, CURLOPT_URL, $REQUEST_URL); 
curl_setopt($ch, CURLOPT_POST, true); 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, $POST_VARS);
// If your PHP host does not have a valid  SSL certificate, you will need to turn off SSL
// Certificate Verification. This is dangerous (!), and should only be done temporarily
// until a valid certificate has been installed
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate.
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate.
 
// Sending the request to the API
$response = curl_exec($ch);
 
// Processing the response
if (!$response) { 
    echo 'API call failed'; 
} 
else
{
    print_r(json_decode($response,true)); 
}

users > get_stats_for_content_type | WS.WebTV API Reference | WebTV Solutions

Professional and affordable online video solutions

API: Introduction

API: Reference

API: Reference