getAnalytics
Get usage and analytics
/analytics
Usage and SDK Samples
curl -X GET -H "Authorization: Basic [[basicHash]]" "https://yourdomain.circlehd.com/api/v2/analytics?email=&media_id=&start_date=&end_date="
import com.circlehd.*;
import com.circlehd.auth.*;
import com.circlehd.model.*;
import com.circlehd.api.AnalyticsApi;
import java.io.File;
import java.util.*;
public class AnalyticsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AnalyticsApi apiInstance = new AnalyticsApi();
String email = email_example; // String | email of the user
String mediaId = mediaId_example; // String | id of the video or slide
String startDate = startDate_example; // String | start date in mm/dd/yyyy format
String endDate = endDate_example; // String | edit date in mm/dd/yyyy format
try {
Stats result = apiInstance.getAnalytics(email, mediaId, startDate, endDate);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnalyticsApi#getAnalytics");
e.printStackTrace();
}
}
}
import com.circlehd.api.AnalyticsApi;
public class AnalyticsApiExample {
public static void main(String[] args) {
AnalyticsApi apiInstance = new AnalyticsApi();
String email = email_example; // String | email of the user
String mediaId = mediaId_example; // String | id of the video or slide
String startDate = startDate_example; // String | start date in mm/dd/yyyy format
String endDate = endDate_example; // String | edit date in mm/dd/yyyy format
try {
Stats result = apiInstance.getAnalytics(email, mediaId, startDate, endDate);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnalyticsApi#getAnalytics");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *email = email_example; // email of the user (optional)
String *mediaId = mediaId_example; // id of the video or slide (optional)
String *startDate = startDate_example; // start date in mm/dd/yyyy format (optional)
String *endDate = endDate_example; // edit date in mm/dd/yyyy format (optional)
AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];
// Get usage and analytics
[apiInstance getAnalyticsWith:email
mediaId:mediaId
startDate:startDate
endDate:endDate
completionHandler: ^(Stats output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var CircleHdAnalyticsApi = require('circle_hd_analytics_api');
var defaultClient = CircleHdAnalyticsApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'
var api = new CircleHdAnalyticsApi.AnalyticsApi()
var opts = {
'email': email_example, // {{String}} email of the user
'mediaId': mediaId_example, // {{String}} id of the video or slide
'startDate': startDate_example, // {{String}} start date in mm/dd/yyyy format
'endDate': endDate_example // {{String}} edit date in mm/dd/yyyy format
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAnalytics(opts, callback);
using System;
using System.Diagnostics;
using com.circlehd.Api;
using com.circlehd.Client;
using com.circlehd.Model;
namespace Example
{
public class getAnalyticsExample
{
public void main()
{
// Configure HTTP basic authorization: basicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new AnalyticsApi();
var email = email_example; // String | email of the user (optional)
var mediaId = mediaId_example; // String | id of the video or slide (optional)
var startDate = startDate_example; // String | start date in mm/dd/yyyy format (optional)
var endDate = endDate_example; // String | edit date in mm/dd/yyyy format (optional)
try
{
// Get usage and analytics
Stats result = apiInstance.getAnalytics(email, mediaId, startDate, endDate);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AnalyticsApi.getAnalytics: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
com.circlehd\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
com.circlehd\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Swagger\Client\ApiAnalyticsApi();
$email = email_example; // String | email of the user
$mediaId = mediaId_example; // String | id of the video or slide
$startDate = startDate_example; // String | start date in mm/dd/yyyy format
$endDate = endDate_example; // String | edit date in mm/dd/yyyy format
try {
$result = $api_instance->getAnalytics($email, $mediaId, $startDate, $endDate);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnalyticsApi->getAnalytics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use com.circlehd::Configuration;
use com.circlehd::AnalyticsApi;
# Configure HTTP basic authorization: basicAuth
$com.circlehd::Configuration::username = 'YOUR_USERNAME';
$com.circlehd::Configuration::password = 'YOUR_PASSWORD';
my $api_instance = com.circlehd::AnalyticsApi->new();
my $email = email_example; # String | email of the user
my $mediaId = mediaId_example; # String | id of the video or slide
my $startDate = startDate_example; # String | start date in mm/dd/yyyy format
my $endDate = endDate_example; # String | edit date in mm/dd/yyyy format
eval {
my $result = $api_instance->getAnalytics(email => $email, mediaId => $mediaId, startDate => $startDate, endDate => $endDate);
print Dumper($result);
};
if ($@) {
warn "Exception when calling AnalyticsApi->getAnalytics: $@\n";
}
from __future__ import print_statement
import time
import com.circlehd
from com.circlehd.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
com.circlehd.configuration.username = 'YOUR_USERNAME'
com.circlehd.configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = com.circlehd.AnalyticsApi()
email = email_example # String | email of the user (optional)
mediaId = mediaId_example # String | id of the video or slide (optional)
startDate = startDate_example # String | start date in mm/dd/yyyy format (optional)
endDate = endDate_example # String | edit date in mm/dd/yyyy format (optional)
try:
# Get usage and analytics
api_response = api_instance.get_analytics(email=email, mediaId=mediaId, startDate=startDate, endDate=endDate)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->getAnalytics: %s\n" % e)
Parameters
Query parameters
Name | Description |
---|---|
String
email of the user
|
|
media_id |
String
id of the video or slide
|
start_date |
String
start date in mm/dd/yyyy format
|
end_date |
String
edit date in mm/dd/yyyy format
|
Responses
Status: 200 - Stats results
Status: 400 - Invalid ID supplied
Status: 401 - Authentication information is missing or invalid
Name | Type | Format | Description |
---|---|---|---|
WWW_Authenticate | String |