CircleHD Analytics API

Analytics

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 = ; // String | email of the user
        String mediaId = ; // String | id of the video or slide
        String startDate = ; // String | start date in mm/dd/yyyy format
        String endDate = ; // 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 = ; // String | email of the user
        String mediaId = ; // String | id of the video or slide
        String startDate = ; // String | start date in mm/dd/yyyy format
        String endDate = ; // 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 of the user (optional)
String *mediaId = ; // id of the video or slide (optional)
String *startDate = ; // start date in mm/dd/yyyy format (optional)
String *endDate = ; // 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': , // {{String}} email of the user
  'mediaId': , // {{String}} id of the video or slide
  'startDate': , // {{String}} start date in mm/dd/yyyy format
  'endDate':  // {{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 = new String(); // String | email of the user (optional) 
            var mediaId = new String(); // String | id of the video or slide (optional) 
            var startDate = new String(); // String | start date in mm/dd/yyyy format (optional) 
            var endDate = new String(); // 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 = ; // String | email of the user
$mediaId = ; // String | id of the video or slide
$startDate = ; // String | start date in mm/dd/yyyy format
$endDate = ; // 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 = ; # String | email of the user
my $mediaId = ; # String | id of the video or slide
my $startDate = ; # String | start date in mm/dd/yyyy format
my $endDate = ; # 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 =  # String | email of the user (optional)
mediaId =  # String | id of the video or slide (optional)
startDate =  # String | start date in mm/dd/yyyy format (optional)
endDate =  # 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
email
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

Status: 404 - user not found

Status: 405 - Validation exception


Media

downloadMedia

Download media


/download/{media_id}

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "https://yourdomain.circlehd.com/api/v2/download/{media_id}"
import com.circlehd.*;
import com.circlehd.auth.*;
import com.circlehd.model.*;
import com.circlehd.api.MediaApi;

import java.io.File;
import java.util.*;

public class MediaApiExample {

    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");

        MediaApi apiInstance = new MediaApi();
        String mediaId = ; // String | ID of the media to get
        try {
            apiInstance.downloadMedia(mediaId);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#downloadMedia");
            e.printStackTrace();
        }
    }
}
import com.circlehd.api.MediaApi;

public class MediaApiExample {

    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        String mediaId = ; // String | ID of the media to get
        try {
            apiInstance.downloadMedia(mediaId);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#downloadMedia");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *mediaId = ; // ID of the media to get

MediaApi *apiInstance = [[MediaApi alloc] init];

// Download media
[apiInstance downloadMediaWith:mediaId
              completionHandler: ^(NSError* error) {
                            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.MediaApi()
var mediaId = ; // {{String}} ID of the media to get

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.downloadMedia(mediaId, callback);
using System;
using System.Diagnostics;
using com.circlehd.Api;
using com.circlehd.Client;
using com.circlehd.Model;

namespace Example
{
    public class downloadMediaExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new MediaApi();
            var mediaId = new String(); // String | ID of the media to get

            try
            {
                // Download media
                apiInstance.downloadMedia(mediaId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediaApi.downloadMedia: " + 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\ApiMediaApi();
$mediaId = ; // String | ID of the media to get

try {
    $api_instance->downloadMedia($mediaId);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->downloadMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use com.circlehd::Configuration;
use com.circlehd::MediaApi;
# Configure HTTP basic authorization: basicAuth
$com.circlehd::Configuration::username = 'YOUR_USERNAME';
$com.circlehd::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = com.circlehd::MediaApi->new();
my $mediaId = ; # String | ID of the media to get

eval { 
    $api_instance->downloadMedia(mediaId => $mediaId);
};
if ($@) {
    warn "Exception when calling MediaApi->downloadMedia: $@\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.MediaApi()
mediaId =  # String | ID of the media to get

try: 
    # Download media
    api_instance.download_media(mediaId)
except ApiException as e:
    print("Exception when calling MediaApi->downloadMedia: %s\n" % e)

Parameters

Path parameters
Name Description
media_id*
String
ID of the media to get
Required

Responses

Status: 302 - Media File URL

Status: 400 - Invalid ID supplied

Status: 401 - Authentication information is missing or invalid

Name Type Format Description
WWW_Authenticate String

Status: 404 - Media not found

Status: 405 - Validation exception


getAllMedias

Get all medias


/media

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "https://yourdomain.circlehd.com/api/v2/media?offset="
import com.circlehd.*;
import com.circlehd.auth.*;
import com.circlehd.model.*;
import com.circlehd.api.MediaApi;

import java.io.File;
import java.util.*;

public class MediaApiExample {

    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");

        MediaApi apiInstance = new MediaApi();
        Integer offset = ; // Integer | Skip results by the number
        try {
            MediaResults result = apiInstance.getAllMedias(offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getAllMedias");
            e.printStackTrace();
        }
    }
}
import com.circlehd.api.MediaApi;

public class MediaApiExample {

    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        Integer offset = ; // Integer | Skip results by the number
        try {
            MediaResults result = apiInstance.getAllMedias(offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getAllMedias");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *offset = ; // Skip results by the number (optional)

MediaApi *apiInstance = [[MediaApi alloc] init];

// Get all medias
[apiInstance getAllMediasWith:offset
              completionHandler: ^(MediaResults 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.MediaApi()
var opts = { 
  'offset':  // {{Integer}} Skip results by the number
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllMedias(opts, callback);
using System;
using System.Diagnostics;
using com.circlehd.Api;
using com.circlehd.Client;
using com.circlehd.Model;

namespace Example
{
    public class getAllMediasExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new MediaApi();
            var offset = new Integer(); // Integer | Skip results by the number (optional) 

            try
            {
                // Get all medias
                MediaResults result = apiInstance.getAllMedias(offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediaApi.getAllMedias: " + 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\ApiMediaApi();
$offset = ; // Integer | Skip results by the number

try {
    $result = $api_instance->getAllMedias($offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->getAllMedias: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use com.circlehd::Configuration;
use com.circlehd::MediaApi;
# Configure HTTP basic authorization: basicAuth
$com.circlehd::Configuration::username = 'YOUR_USERNAME';
$com.circlehd::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = com.circlehd::MediaApi->new();
my $offset = ; # Integer | Skip results by the number

eval { 
    my $result = $api_instance->getAllMedias(offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaApi->getAllMedias: $@\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.MediaApi()
offset =  # Integer | Skip results by the number (optional)

try: 
    # Get all medias
    api_response = api_instance.get_all_medias(offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->getAllMedias: %s\n" % e)

Parameters

Query parameters
Name Description
offset
Integer
Skip results by the number

Responses

Status: 200 - results


getMedia

Get media information


/media/{media_id}

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "https://yourdomain.circlehd.com/api/v2/media/{media_id}"
import com.circlehd.*;
import com.circlehd.auth.*;
import com.circlehd.model.*;
import com.circlehd.api.MediaApi;

import java.io.File;
import java.util.*;

public class MediaApiExample {

    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");

        MediaApi apiInstance = new MediaApi();
        String mediaId = ; // String | ID of the media to get
        try {
            Media result = apiInstance.getMedia(mediaId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getMedia");
            e.printStackTrace();
        }
    }
}
import com.circlehd.api.MediaApi;

public class MediaApiExample {

    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        String mediaId = ; // String | ID of the media to get
        try {
            Media result = apiInstance.getMedia(mediaId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getMedia");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *mediaId = ; // ID of the media to get

MediaApi *apiInstance = [[MediaApi alloc] init];

// Get media information
[apiInstance getMediaWith:mediaId
              completionHandler: ^(Media 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.MediaApi()
var mediaId = ; // {{String}} ID of the media to get

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMedia(mediaId, callback);
using System;
using System.Diagnostics;
using com.circlehd.Api;
using com.circlehd.Client;
using com.circlehd.Model;

namespace Example
{
    public class getMediaExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new MediaApi();
            var mediaId = new String(); // String | ID of the media to get

            try
            {
                // Get media information
                Media result = apiInstance.getMedia(mediaId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediaApi.getMedia: " + 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\ApiMediaApi();
$mediaId = ; // String | ID of the media to get

try {
    $result = $api_instance->getMedia($mediaId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->getMedia: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use com.circlehd::Configuration;
use com.circlehd::MediaApi;
# Configure HTTP basic authorization: basicAuth
$com.circlehd::Configuration::username = 'YOUR_USERNAME';
$com.circlehd::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = com.circlehd::MediaApi->new();
my $mediaId = ; # String | ID of the media to get

eval { 
    my $result = $api_instance->getMedia(mediaId => $mediaId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaApi->getMedia: $@\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.MediaApi()
mediaId =  # String | ID of the media to get

try: 
    # Get media information
    api_response = api_instance.get_media(mediaId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->getMedia: %s\n" % e)

Parameters

Path parameters
Name Description
media_id*
String
ID of the media to get
Required

Responses

Status: 200 - media object

Status: 400 - Invalid ID supplied

Status: 401 - Authentication information is missing or invalid

Name Type Format Description
WWW_Authenticate String

Status: 404 - user not found

Status: 405 - Validation exception


searchMedias

Get media information


/media/search

Usage and SDK Samples

curl -X GET -H "Authorization: Basic [[basicHash]]" "https://yourdomain.circlehd.com/api/v2/media/search?query="
import com.circlehd.*;
import com.circlehd.auth.*;
import com.circlehd.model.*;
import com.circlehd.api.MediaApi;

import java.io.File;
import java.util.*;

public class MediaApiExample {

    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");

        MediaApi apiInstance = new MediaApi();
        String query = ; // String | keywords to search for in title or tags
        try {
            MediaResults result = apiInstance.searchMedias(query);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#searchMedias");
            e.printStackTrace();
        }
    }
}
import com.circlehd.api.MediaApi;

public class MediaApiExample {

    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        String query = ; // String | keywords to search for in title or tags
        try {
            MediaResults result = apiInstance.searchMedias(query);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#searchMedias");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *query = ; // keywords to search for in title or tags

MediaApi *apiInstance = [[MediaApi alloc] init];

// Get media information
[apiInstance searchMediasWith:query
              completionHandler: ^(MediaResults 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.MediaApi()
var query = ; // {{String}} keywords to search for in title or tags

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchMedias(query, callback);
using System;
using System.Diagnostics;
using com.circlehd.Api;
using com.circlehd.Client;
using com.circlehd.Model;

namespace Example
{
    public class searchMediasExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new MediaApi();
            var query = new String(); // String | keywords to search for in title or tags

            try
            {
                // Get media information
                MediaResults result = apiInstance.searchMedias(query);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediaApi.searchMedias: " + 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\ApiMediaApi();
$query = ; // String | keywords to search for in title or tags

try {
    $result = $api_instance->searchMedias($query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->searchMedias: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use com.circlehd::Configuration;
use com.circlehd::MediaApi;
# Configure HTTP basic authorization: basicAuth
$com.circlehd::Configuration::username = 'YOUR_USERNAME';
$com.circlehd::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = com.circlehd::MediaApi->new();
my $query = ; # String | keywords to search for in title or tags

eval { 
    my $result = $api_instance->searchMedias(query => $query);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MediaApi->searchMedias: $@\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.MediaApi()
query =  # String | keywords to search for in title or tags

try: 
    # Get media information
    api_response = api_instance.search_medias(query)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->searchMedias: %s\n" % e)

Parameters

Query parameters
Name Description
query*
String
keywords to search for in title or tags
Required

Responses

Status: 200 - search results

Status: 401 - Authentication information is missing or invalid

Name Type Format Description
WWW_Authenticate String

Status: 405 - Validation exception