Dive.tv - Recommendation Engine API

Dashboard

getMediaContent

List Media content

List the media content according a criterias


/v1/media_content

Usage and SDK Samples

curl -X GET -H "x-api-key: [[apiKey]]" "https://recommendations.dive.tv/v1/media_content?byPageSize=&byTitle=&byPage=&byYear=&byType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardApi;

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

public class DashboardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DashboardApi apiInstance = new DashboardApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        Integer byPageSize = 56; // Integer | Number of media returned. Max 50#{You may also query the endpont using the parameter name pageSize}
        String byTitle = byTitle_example; // String | Title of the movie#{You may also query the endpont using the parameter name title}
        Integer byPage = 56; // Integer | Number of page#{You may also query the endpont using the parameter name page}
        Integer byYear = 56; // Integer | Year of the media#{You may also query the endpont using the parameter name year}
        String byType = byType_example; // String | Content type to be queried#{You may also query the endpont using the parameter name type}
        try {
            apiInstance.getMediaContent(xApiKey, clientId, byPageSize, byTitle, byPage, byYear, byType);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardApi#getMediaContent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardApi;

public class DashboardApiExample {

    public static void main(String[] args) {
        DashboardApi apiInstance = new DashboardApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        Integer byPageSize = 56; // Integer | Number of media returned. Max 50#{You may also query the endpont using the parameter name pageSize}
        String byTitle = byTitle_example; // String | Title of the movie#{You may also query the endpont using the parameter name title}
        Integer byPage = 56; // Integer | Number of page#{You may also query the endpont using the parameter name page}
        Integer byYear = 56; // Integer | Year of the media#{You may also query the endpont using the parameter name year}
        String byType = byType_example; // String | Content type to be queried#{You may also query the endpont using the parameter name type}
        try {
            apiInstance.getMediaContent(xApiKey, clientId, byPageSize, byTitle, byPage, byYear, byType);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardApi#getMediaContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *xApiKey = xApiKey_example; // Client API Key
String *clientId = clientId_example; // Client Id. Each client will be provided with a clientId and an API Key
Integer *byPageSize = 56; // Number of media returned. Max 50#{You may also query the endpont using the parameter name pageSize} (optional)
String *byTitle = byTitle_example; // Title of the movie#{You may also query the endpont using the parameter name title} (optional)
Integer *byPage = 56; // Number of page#{You may also query the endpont using the parameter name page} (optional)
Integer *byYear = 56; // Year of the media#{You may also query the endpont using the parameter name year} (optional)
String *byType = byType_example; // Content type to be queried#{You may also query the endpont using the parameter name type} (optional)

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

// List Media content
[apiInstance getMediaContentWith:xApiKey
    clientId:clientId
    byPageSize:byPageSize
    byTitle:byTitle
    byPage:byPage
    byYear:byYear
    byType:byType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecoEngineDev = require('reco_engine_dev');
var defaultClient = RecoEngineDev.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new RecoEngineDev.DashboardApi()

var xApiKey = xApiKey_example; // {String} Client API Key

var clientId = clientId_example; // {String} Client Id. Each client will be provided with a clientId and an API Key

var opts = { 
  'byPageSize': 56, // {Integer} Number of media returned. Max 50#{You may also query the endpont using the parameter name pageSize}
  'byTitle': byTitle_example, // {String} Title of the movie#{You may also query the endpont using the parameter name title}
  'byPage': 56, // {Integer} Number of page#{You may also query the endpont using the parameter name page}
  'byYear': 56, // {Integer} Year of the media#{You may also query the endpont using the parameter name year}
  'byType': byType_example // {String} Content type to be queried#{You may also query the endpont using the parameter name type}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getMediaContent(xApiKey, clientId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMediaContentExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DashboardApi();
            var xApiKey = xApiKey_example;  // String | Client API Key
            var clientId = clientId_example;  // String | Client Id. Each client will be provided with a clientId and an API Key
            var byPageSize = 56;  // Integer | Number of media returned. Max 50#{You may also query the endpont using the parameter name pageSize} (optional) 
            var byTitle = byTitle_example;  // String | Title of the movie#{You may also query the endpont using the parameter name title} (optional) 
            var byPage = 56;  // Integer | Number of page#{You may also query the endpont using the parameter name page} (optional) 
            var byYear = 56;  // Integer | Year of the media#{You may also query the endpont using the parameter name year} (optional) 
            var byType = byType_example;  // String | Content type to be queried#{You may also query the endpont using the parameter name type} (optional) 

            try
            {
                // List Media content
                apiInstance.getMediaContent(xApiKey, clientId, byPageSize, byTitle, byPage, byYear, byType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardApi.getMediaContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\DashboardApi();
$xApiKey = xApiKey_example; // String | Client API Key
$clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
$byPageSize = 56; // Integer | Number of media returned. Max 50#{You may also query the endpont using the parameter name pageSize}
$byTitle = byTitle_example; // String | Title of the movie#{You may also query the endpont using the parameter name title}
$byPage = 56; // Integer | Number of page#{You may also query the endpont using the parameter name page}
$byYear = 56; // Integer | Year of the media#{You may also query the endpont using the parameter name year}
$byType = byType_example; // String | Content type to be queried#{You may also query the endpont using the parameter name type}

try {
    $api_instance->getMediaContent($xApiKey, $clientId, $byPageSize, $byTitle, $byPage, $byYear, $byType);
} catch (Exception $e) {
    echo 'Exception when calling DashboardApi->getMediaContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardApi->new();
my $xApiKey = xApiKey_example; # String | Client API Key
my $clientId = clientId_example; # String | Client Id. Each client will be provided with a clientId and an API Key
my $byPageSize = 56; # Integer | Number of media returned. Max 50#{You may also query the endpont using the parameter name pageSize}
my $byTitle = byTitle_example; # String | Title of the movie#{You may also query the endpont using the parameter name title}
my $byPage = 56; # Integer | Number of page#{You may also query the endpont using the parameter name page}
my $byYear = 56; # Integer | Year of the media#{You may also query the endpont using the parameter name year}
my $byType = byType_example; # String | Content type to be queried#{You may also query the endpont using the parameter name type}

eval { 
    $api_instance->getMediaContent(xApiKey => $xApiKey, clientId => $clientId, byPageSize => $byPageSize, byTitle => $byTitle, byPage => $byPage, byYear => $byYear, byType => $byType);
};
if ($@) {
    warn "Exception when calling DashboardApi->getMediaContent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DashboardApi()
xApiKey = xApiKey_example # String | Client API Key
clientId = clientId_example # String | Client Id. Each client will be provided with a clientId and an API Key
byPageSize = 56 # Integer | Number of media returned. Max 50#{You may also query the endpont using the parameter name pageSize} (optional)
byTitle = byTitle_example # String | Title of the movie#{You may also query the endpont using the parameter name title} (optional)
byPage = 56 # Integer | Number of page#{You may also query the endpont using the parameter name page} (optional)
byYear = 56 # Integer | Year of the media#{You may also query the endpont using the parameter name year} (optional)
byType = byType_example # String | Content type to be queried#{You may also query the endpont using the parameter name type} (optional)

try: 
    # List Media content
    api_instance.get_media_content(xApiKey, clientId, byPageSize=byPageSize, byTitle=byTitle, byPage=byPage, byYear=byYear, byType=byType)
except ApiException as e:
    print("Exception when calling DashboardApi->getMediaContent: %s\n" % e)

Parameters

Header parameters
Name Description
x-api-key*
String
Client API Key
Required
client-id*
String
Client Id. Each client will be provided with a clientId and an API Key
Required
Query parameters
Name Description
byPageSize
Integer
Number of media returned. Max 50
You may also query the endpont using the parameter name pageSize
byTitle
String
Title of the movie
You may also query the endpont using the parameter name title
byPage
Integer
Number of page
You may also query the endpont using the parameter name page
byYear
Integer
Year of the media
You may also query the endpont using the parameter name year
byType
String
Content type to be queried
You may also query the endpont using the parameter name type

Responses

Status: 200 - OK

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 400 - Invalid Request

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 500 - Error Response

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 504 - Gateway Timeout

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Externals

deleteExternalAccount

Delete Profile by external account id

Deletes a user profile on the system


/v1/account/{externalAccountId}

Usage and SDK Samples

curl -X DELETE -H "x-api-key: [[apiKey]]" "https://recommendations.dive.tv/v1/account/{externalAccountId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExternalsApi;

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

public class ExternalsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ExternalsApi apiInstance = new ExternalsApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String externalAccountId = externalAccountId_example; // String | External Account Id to be deleted
        Data data = ; // Data | form data
        try {
            BigDecimal result = apiInstance.deleteExternalAccount(xApiKey, clientId, externalAccountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalsApi#deleteExternalAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExternalsApi;

public class ExternalsApiExample {

    public static void main(String[] args) {
        ExternalsApi apiInstance = new ExternalsApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String externalAccountId = externalAccountId_example; // String | External Account Id to be deleted
        Data data = ; // Data | form data
        try {
            BigDecimal result = apiInstance.deleteExternalAccount(xApiKey, clientId, externalAccountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalsApi#deleteExternalAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *xApiKey = xApiKey_example; // Client API Key
String *clientId = clientId_example; // Client Id. Each client will be provided with a clientId and an API Key
String *externalAccountId = externalAccountId_example; // External Account Id to be deleted
Data *data = ; // form data (optional)

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

// Delete Profile by external account id
[apiInstance deleteExternalAccountWith:xApiKey
    clientId:clientId
    externalAccountId:externalAccountId
    data:data
              completionHandler: ^(BigDecimal output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecoEngineDev = require('reco_engine_dev');
var defaultClient = RecoEngineDev.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new RecoEngineDev.ExternalsApi()

var xApiKey = xApiKey_example; // {String} Client API Key

var clientId = clientId_example; // {String} Client Id. Each client will be provided with a clientId and an API Key

var externalAccountId = externalAccountId_example; // {String} External Account Id to be deleted

var opts = { 
  'data':  // {Data} form data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteExternalAccount(xApiKey, clientId, externalAccountId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExternalAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new ExternalsApi();
            var xApiKey = xApiKey_example;  // String | Client API Key
            var clientId = clientId_example;  // String | Client Id. Each client will be provided with a clientId and an API Key
            var externalAccountId = externalAccountId_example;  // String | External Account Id to be deleted
            var data = new Data(); // Data | form data (optional) 

            try
            {
                // Delete Profile by external account id
                BigDecimal result = apiInstance.deleteExternalAccount(xApiKey, clientId, externalAccountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExternalsApi.deleteExternalAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ExternalsApi();
$xApiKey = xApiKey_example; // String | Client API Key
$clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
$externalAccountId = externalAccountId_example; // String | External Account Id to be deleted
$data = ; // Data | form data

try {
    $result = $api_instance->deleteExternalAccount($xApiKey, $clientId, $externalAccountId, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExternalsApi->deleteExternalAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExternalsApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExternalsApi->new();
my $xApiKey = xApiKey_example; # String | Client API Key
my $clientId = clientId_example; # String | Client Id. Each client will be provided with a clientId and an API Key
my $externalAccountId = externalAccountId_example; # String | External Account Id to be deleted
my $data = WWW::SwaggerClient::Object::Data->new(); # Data | form data

eval { 
    my $result = $api_instance->deleteExternalAccount(xApiKey => $xApiKey, clientId => $clientId, externalAccountId => $externalAccountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExternalsApi->deleteExternalAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExternalsApi()
xApiKey = xApiKey_example # String | Client API Key
clientId = clientId_example # String | Client Id. Each client will be provided with a clientId and an API Key
externalAccountId = externalAccountId_example # String | External Account Id to be deleted
data =  # Data | form data (optional)

try: 
    # Delete Profile by external account id
    api_response = api_instance.delete_external_account(xApiKey, clientId, externalAccountId, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExternalsApi->deleteExternalAccount: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountId*
String
External Account Id to be deleted
Required
Header parameters
Name Description
x-api-key*
String
Client API Key
Required
client-id*
String
Client Id. Each client will be provided with a clientId and an API Key
Required
Body parameters
Name Description
data

Responses

Status: 200 - Records deleted

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 400 - Invalid Request

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 500 - Error Response

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 504 - Gateway Timeout

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

deleteExternalProfile

Delete Profile by external account id and profile id

Deletes a user profile on the system


/v1/account/{externalAccountId}/profile/{externalProfileId}

Usage and SDK Samples

curl -X DELETE -H "x-api-key: [[apiKey]]" "https://recommendations.dive.tv/v1/account/{externalAccountId}/profile/{externalProfileId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExternalsApi;

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

public class ExternalsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ExternalsApi apiInstance = new ExternalsApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String externalAccountId = externalAccountId_example; // String | External Account Id to be deleted
        String externalProfileId = externalProfileId_example; // String | External Profile Id to be patched
        Data_2 data = ; // Data_2 | form data
        try {
            BigDecimal result = apiInstance.deleteExternalProfile(xApiKey, clientId, externalAccountId, externalProfileId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalsApi#deleteExternalProfile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExternalsApi;

public class ExternalsApiExample {

    public static void main(String[] args) {
        ExternalsApi apiInstance = new ExternalsApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String externalAccountId = externalAccountId_example; // String | External Account Id to be deleted
        String externalProfileId = externalProfileId_example; // String | External Profile Id to be patched
        Data_2 data = ; // Data_2 | form data
        try {
            BigDecimal result = apiInstance.deleteExternalProfile(xApiKey, clientId, externalAccountId, externalProfileId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalsApi#deleteExternalProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *xApiKey = xApiKey_example; // Client API Key
String *clientId = clientId_example; // Client Id. Each client will be provided with a clientId and an API Key
String *externalAccountId = externalAccountId_example; // External Account Id to be deleted
String *externalProfileId = externalProfileId_example; // External Profile Id to be patched
Data_2 *data = ; // form data (optional)

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

// Delete Profile by external account id and profile id
[apiInstance deleteExternalProfileWith:xApiKey
    clientId:clientId
    externalAccountId:externalAccountId
    externalProfileId:externalProfileId
    data:data
              completionHandler: ^(BigDecimal output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecoEngineDev = require('reco_engine_dev');
var defaultClient = RecoEngineDev.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new RecoEngineDev.ExternalsApi()

var xApiKey = xApiKey_example; // {String} Client API Key

var clientId = clientId_example; // {String} Client Id. Each client will be provided with a clientId and an API Key

var externalAccountId = externalAccountId_example; // {String} External Account Id to be deleted

var externalProfileId = externalProfileId_example; // {String} External Profile Id to be patched

var opts = { 
  'data':  // {Data_2} form data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteExternalProfile(xApiKey, clientId, externalAccountId, externalProfileId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteExternalProfileExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new ExternalsApi();
            var xApiKey = xApiKey_example;  // String | Client API Key
            var clientId = clientId_example;  // String | Client Id. Each client will be provided with a clientId and an API Key
            var externalAccountId = externalAccountId_example;  // String | External Account Id to be deleted
            var externalProfileId = externalProfileId_example;  // String | External Profile Id to be patched
            var data = new Data_2(); // Data_2 | form data (optional) 

            try
            {
                // Delete Profile by external account id and profile id
                BigDecimal result = apiInstance.deleteExternalProfile(xApiKey, clientId, externalAccountId, externalProfileId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExternalsApi.deleteExternalProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ExternalsApi();
$xApiKey = xApiKey_example; // String | Client API Key
$clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
$externalAccountId = externalAccountId_example; // String | External Account Id to be deleted
$externalProfileId = externalProfileId_example; // String | External Profile Id to be patched
$data = ; // Data_2 | form data

try {
    $result = $api_instance->deleteExternalProfile($xApiKey, $clientId, $externalAccountId, $externalProfileId, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExternalsApi->deleteExternalProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExternalsApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExternalsApi->new();
my $xApiKey = xApiKey_example; # String | Client API Key
my $clientId = clientId_example; # String | Client Id. Each client will be provided with a clientId and an API Key
my $externalAccountId = externalAccountId_example; # String | External Account Id to be deleted
my $externalProfileId = externalProfileId_example; # String | External Profile Id to be patched
my $data = WWW::SwaggerClient::Object::Data_2->new(); # Data_2 | form data

eval { 
    my $result = $api_instance->deleteExternalProfile(xApiKey => $xApiKey, clientId => $clientId, externalAccountId => $externalAccountId, externalProfileId => $externalProfileId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExternalsApi->deleteExternalProfile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExternalsApi()
xApiKey = xApiKey_example # String | Client API Key
clientId = clientId_example # String | Client Id. Each client will be provided with a clientId and an API Key
externalAccountId = externalAccountId_example # String | External Account Id to be deleted
externalProfileId = externalProfileId_example # String | External Profile Id to be patched
data =  # Data_2 | form data (optional)

try: 
    # Delete Profile by external account id and profile id
    api_response = api_instance.delete_external_profile(xApiKey, clientId, externalAccountId, externalProfileId, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExternalsApi->deleteExternalProfile: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountId*
String
External Account Id to be deleted
Required
externalProfileId*
String
External Profile Id to be patched
Required
Header parameters
Name Description
x-api-key*
String
Client API Key
Required
client-id*
String
Client Id. Each client will be provided with a clientId and an API Key
Required
Body parameters
Name Description
data

Responses

Status: 200 - Records deleted

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 400 - Invalid Request

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 500 - Error Response

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 504 - Gateway Timeout

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

patchExternalAccount

Patch Profile by external account id

Updates a user profile on the system


/v1/account/{externalAccountId}

Usage and SDK Samples

curl -X PATCH -H "x-api-key: [[apiKey]]" "https://recommendations.dive.tv/v1/account/{externalAccountId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExternalsApi;

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

public class ExternalsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ExternalsApi apiInstance = new ExternalsApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String externalAccountId = externalAccountId_example; // String | External Account Id to be patched
        Data_1 data = ; // Data_1 | form data
        try {
            array[Object] result = apiInstance.patchExternalAccount(xApiKey, clientId, externalAccountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalsApi#patchExternalAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExternalsApi;

public class ExternalsApiExample {

    public static void main(String[] args) {
        ExternalsApi apiInstance = new ExternalsApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String externalAccountId = externalAccountId_example; // String | External Account Id to be patched
        Data_1 data = ; // Data_1 | form data
        try {
            array[Object] result = apiInstance.patchExternalAccount(xApiKey, clientId, externalAccountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalsApi#patchExternalAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *xApiKey = xApiKey_example; // Client API Key
String *clientId = clientId_example; // Client Id. Each client will be provided with a clientId and an API Key
String *externalAccountId = externalAccountId_example; // External Account Id to be patched
Data_1 *data = ; // form data (optional)

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

// Patch Profile by external account id
[apiInstance patchExternalAccountWith:xApiKey
    clientId:clientId
    externalAccountId:externalAccountId
    data:data
              completionHandler: ^(array[Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecoEngineDev = require('reco_engine_dev');
var defaultClient = RecoEngineDev.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new RecoEngineDev.ExternalsApi()

var xApiKey = xApiKey_example; // {String} Client API Key

var clientId = clientId_example; // {String} Client Id. Each client will be provided with a clientId and an API Key

var externalAccountId = externalAccountId_example; // {String} External Account Id to be patched

var opts = { 
  'data':  // {Data_1} form data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchExternalAccount(xApiKey, clientId, externalAccountId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchExternalAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new ExternalsApi();
            var xApiKey = xApiKey_example;  // String | Client API Key
            var clientId = clientId_example;  // String | Client Id. Each client will be provided with a clientId and an API Key
            var externalAccountId = externalAccountId_example;  // String | External Account Id to be patched
            var data = new Data_1(); // Data_1 | form data (optional) 

            try
            {
                // Patch Profile by external account id
                array[Object] result = apiInstance.patchExternalAccount(xApiKey, clientId, externalAccountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExternalsApi.patchExternalAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ExternalsApi();
$xApiKey = xApiKey_example; // String | Client API Key
$clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
$externalAccountId = externalAccountId_example; // String | External Account Id to be patched
$data = ; // Data_1 | form data

try {
    $result = $api_instance->patchExternalAccount($xApiKey, $clientId, $externalAccountId, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExternalsApi->patchExternalAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExternalsApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExternalsApi->new();
my $xApiKey = xApiKey_example; # String | Client API Key
my $clientId = clientId_example; # String | Client Id. Each client will be provided with a clientId and an API Key
my $externalAccountId = externalAccountId_example; # String | External Account Id to be patched
my $data = WWW::SwaggerClient::Object::Data_1->new(); # Data_1 | form data

eval { 
    my $result = $api_instance->patchExternalAccount(xApiKey => $xApiKey, clientId => $clientId, externalAccountId => $externalAccountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExternalsApi->patchExternalAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExternalsApi()
xApiKey = xApiKey_example # String | Client API Key
clientId = clientId_example # String | Client Id. Each client will be provided with a clientId and an API Key
externalAccountId = externalAccountId_example # String | External Account Id to be patched
data =  # Data_1 | form data (optional)

try: 
    # Patch Profile by external account id
    api_response = api_instance.patch_external_account(xApiKey, clientId, externalAccountId, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExternalsApi->patchExternalAccount: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountId*
String
External Account Id to be patched
Required
Header parameters
Name Description
x-api-key*
String
Client API Key
Required
client-id*
String
Client Id. Each client will be provided with a clientId and an API Key
Required
Body parameters
Name Description
data

Responses

Status: 200 - Profile result

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 400 - Invalid Request

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 500 - Error Response

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 504 - Gateway Timeout

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

patchExternalProfile

Patch Profile by external account id and profile id

Updates a user profile on the system


/v1/account/{externalAccountId}/profile/{externalProfileId}

Usage and SDK Samples

curl -X PATCH -H "x-api-key: [[apiKey]]" "https://recommendations.dive.tv/v1/account/{externalAccountId}/profile/{externalProfileId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExternalsApi;

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

public class ExternalsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ExternalsApi apiInstance = new ExternalsApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String externalAccountId = externalAccountId_example; // String | External Account Id to be patched
        String externalProfileId = externalProfileId_example; // String | External Profile Id to be patched
        Data_3 data = ; // Data_3 | form data
        try {
            array[Object] result = apiInstance.patchExternalProfile(xApiKey, clientId, externalAccountId, externalProfileId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalsApi#patchExternalProfile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExternalsApi;

public class ExternalsApiExample {

    public static void main(String[] args) {
        ExternalsApi apiInstance = new ExternalsApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String externalAccountId = externalAccountId_example; // String | External Account Id to be patched
        String externalProfileId = externalProfileId_example; // String | External Profile Id to be patched
        Data_3 data = ; // Data_3 | form data
        try {
            array[Object] result = apiInstance.patchExternalProfile(xApiKey, clientId, externalAccountId, externalProfileId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalsApi#patchExternalProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *xApiKey = xApiKey_example; // Client API Key
String *clientId = clientId_example; // Client Id. Each client will be provided with a clientId and an API Key
String *externalAccountId = externalAccountId_example; // External Account Id to be patched
String *externalProfileId = externalProfileId_example; // External Profile Id to be patched
Data_3 *data = ; // form data (optional)

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

// Patch Profile by external account id and profile id
[apiInstance patchExternalProfileWith:xApiKey
    clientId:clientId
    externalAccountId:externalAccountId
    externalProfileId:externalProfileId
    data:data
              completionHandler: ^(array[Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecoEngineDev = require('reco_engine_dev');
var defaultClient = RecoEngineDev.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new RecoEngineDev.ExternalsApi()

var xApiKey = xApiKey_example; // {String} Client API Key

var clientId = clientId_example; // {String} Client Id. Each client will be provided with a clientId and an API Key

var externalAccountId = externalAccountId_example; // {String} External Account Id to be patched

var externalProfileId = externalProfileId_example; // {String} External Profile Id to be patched

var opts = { 
  'data':  // {Data_3} form data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchExternalProfile(xApiKey, clientId, externalAccountId, externalProfileId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchExternalProfileExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new ExternalsApi();
            var xApiKey = xApiKey_example;  // String | Client API Key
            var clientId = clientId_example;  // String | Client Id. Each client will be provided with a clientId and an API Key
            var externalAccountId = externalAccountId_example;  // String | External Account Id to be patched
            var externalProfileId = externalProfileId_example;  // String | External Profile Id to be patched
            var data = new Data_3(); // Data_3 | form data (optional) 

            try
            {
                // Patch Profile by external account id and profile id
                array[Object] result = apiInstance.patchExternalProfile(xApiKey, clientId, externalAccountId, externalProfileId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExternalsApi.patchExternalProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ExternalsApi();
$xApiKey = xApiKey_example; // String | Client API Key
$clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
$externalAccountId = externalAccountId_example; // String | External Account Id to be patched
$externalProfileId = externalProfileId_example; // String | External Profile Id to be patched
$data = ; // Data_3 | form data

try {
    $result = $api_instance->patchExternalProfile($xApiKey, $clientId, $externalAccountId, $externalProfileId, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExternalsApi->patchExternalProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExternalsApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExternalsApi->new();
my $xApiKey = xApiKey_example; # String | Client API Key
my $clientId = clientId_example; # String | Client Id. Each client will be provided with a clientId and an API Key
my $externalAccountId = externalAccountId_example; # String | External Account Id to be patched
my $externalProfileId = externalProfileId_example; # String | External Profile Id to be patched
my $data = WWW::SwaggerClient::Object::Data_3->new(); # Data_3 | form data

eval { 
    my $result = $api_instance->patchExternalProfile(xApiKey => $xApiKey, clientId => $clientId, externalAccountId => $externalAccountId, externalProfileId => $externalProfileId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExternalsApi->patchExternalProfile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExternalsApi()
xApiKey = xApiKey_example # String | Client API Key
clientId = clientId_example # String | Client Id. Each client will be provided with a clientId and an API Key
externalAccountId = externalAccountId_example # String | External Account Id to be patched
externalProfileId = externalProfileId_example # String | External Profile Id to be patched
data =  # Data_3 | form data (optional)

try: 
    # Patch Profile by external account id and profile id
    api_response = api_instance.patch_external_profile(xApiKey, clientId, externalAccountId, externalProfileId, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExternalsApi->patchExternalProfile: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountId*
String
External Account Id to be patched
Required
externalProfileId*
String
External Profile Id to be patched
Required
Header parameters
Name Description
x-api-key*
String
Client API Key
Required
client-id*
String
Client Id. Each client will be provided with a clientId and an API Key
Required
Body parameters
Name Description
data

Responses

Status: 200 - Profile result

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 400 - Invalid Request

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 500 - Error Response

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 504 - Gateway Timeout

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Profiles

deleteProfile

Delete Profile

Removes an existent profile from the system


/v1/profile/{id}

Usage and SDK Samples

curl -X DELETE -H "x-api-key: [[apiKey]]" "https://recommendations.dive.tv/v1/profile/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProfilesApi;

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

public class ProfilesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ProfilesApi apiInstance = new ProfilesApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String id = id_example; // String | Profile ID to be deleted
        try {
            BigDecimal result = apiInstance.deleteProfile(xApiKey, clientId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#deleteProfile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProfilesApi;

public class ProfilesApiExample {

    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String id = id_example; // String | Profile ID to be deleted
        try {
            BigDecimal result = apiInstance.deleteProfile(xApiKey, clientId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#deleteProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *xApiKey = xApiKey_example; // Client API Key
String *clientId = clientId_example; // Client Id. Each client will be provided with a clientId and an API Key
String *id = id_example; // Profile ID to be deleted

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

// Delete Profile
[apiInstance deleteProfileWith:xApiKey
    clientId:clientId
    id:id
              completionHandler: ^(BigDecimal output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecoEngineDev = require('reco_engine_dev');
var defaultClient = RecoEngineDev.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new RecoEngineDev.ProfilesApi()

var xApiKey = xApiKey_example; // {String} Client API Key

var clientId = clientId_example; // {String} Client Id. Each client will be provided with a clientId and an API Key

var id = id_example; // {String} Profile ID to be deleted


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteProfile(xApiKey, clientId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProfileExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new ProfilesApi();
            var xApiKey = xApiKey_example;  // String | Client API Key
            var clientId = clientId_example;  // String | Client Id. Each client will be provided with a clientId and an API Key
            var id = id_example;  // String | Profile ID to be deleted

            try
            {
                // Delete Profile
                BigDecimal result = apiInstance.deleteProfile(xApiKey, clientId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProfilesApi.deleteProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ProfilesApi();
$xApiKey = xApiKey_example; // String | Client API Key
$clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
$id = id_example; // String | Profile ID to be deleted

try {
    $result = $api_instance->deleteProfile($xApiKey, $clientId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfilesApi->deleteProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProfilesApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProfilesApi->new();
my $xApiKey = xApiKey_example; # String | Client API Key
my $clientId = clientId_example; # String | Client Id. Each client will be provided with a clientId and an API Key
my $id = id_example; # String | Profile ID to be deleted

eval { 
    my $result = $api_instance->deleteProfile(xApiKey => $xApiKey, clientId => $clientId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfilesApi->deleteProfile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProfilesApi()
xApiKey = xApiKey_example # String | Client API Key
clientId = clientId_example # String | Client Id. Each client will be provided with a clientId and an API Key
id = id_example # String | Profile ID to be deleted

try: 
    # Delete Profile
    api_response = api_instance.delete_profile(xApiKey, clientId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->deleteProfile: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Profile ID to be deleted
Required
Header parameters
Name Description
x-api-key*
String
Client API Key
Required
client-id*
String
Client Id. Each client will be provided with a clientId and an API Key
Required

Responses

Status: 200 - Records deleted

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 400 - Invalid Request

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 500 - Error Response

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 504 - Gateway Timeout

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

getProfile

Get Profile

List all profiles or a single profile by Id on the system


/v1/profile

Usage and SDK Samples

curl -X GET -H "x-api-key: [[apiKey]]" "https://recommendations.dive.tv/v1/profile?byId=&byExternalAccountId=&byExternalProfileId=&byPageSize=&byPage="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProfilesApi;

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

public class ProfilesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ProfilesApi apiInstance = new ProfilesApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        Integer byId = 56; // Integer | Profile ID to be retrieved
You may also query the endpont using the parameter name id
String byExternalAccountId = byExternalAccountId_example; // String | account id in the Client System
You may also query the endpont using the parameter name externalAccountId
String byExternalProfileId = byExternalProfileId_example; // String | profile id in the Client System
You may also query the endpont using the parameter name externalProfileId
Integer byPageSize = 56; // Integer | Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
Integer byPage = 56; // Integer | Number of page
You may also query the endpont using the parameter name page
try { inline_response_200_1 result = apiInstance.getProfile(xApiKey, clientId, byId, byExternalAccountId, byExternalProfileId, byPageSize, byPage); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ProfilesApi#getProfile"); e.printStackTrace(); } } }
import io.swagger.client.api.ProfilesApi;

public class ProfilesApiExample {

    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        Integer byId = 56; // Integer | Profile ID to be retrieved
You may also query the endpont using the parameter name id
String byExternalAccountId = byExternalAccountId_example; // String | account id in the Client System
You may also query the endpont using the parameter name externalAccountId
String byExternalProfileId = byExternalProfileId_example; // String | profile id in the Client System
You may also query the endpont using the parameter name externalProfileId
Integer byPageSize = 56; // Integer | Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
Integer byPage = 56; // Integer | Number of page
You may also query the endpont using the parameter name page
try { inline_response_200_1 result = apiInstance.getProfile(xApiKey, clientId, byId, byExternalAccountId, byExternalProfileId, byPageSize, byPage); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ProfilesApi#getProfile"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *xApiKey = xApiKey_example; // Client API Key
String *clientId = clientId_example; // Client Id. Each client will be provided with a clientId and an API Key
Integer *byId = 56; // Profile ID to be retrieved
You may also query the endpont using the parameter name id
(optional) String *byExternalAccountId = byExternalAccountId_example; // account id in the Client System
You may also query the endpont using the parameter name externalAccountId
(optional) String *byExternalProfileId = byExternalProfileId_example; // profile id in the Client System
You may also query the endpont using the parameter name externalProfileId
(optional) Integer *byPageSize = 56; // Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
(optional) Integer *byPage = 56; // Number of page
You may also query the endpont using the parameter name page
(optional) ProfilesApi *apiInstance = [[ProfilesApi alloc] init]; // Get Profile [apiInstance getProfileWith:xApiKey clientId:clientId byId:byId byExternalAccountId:byExternalAccountId byExternalProfileId:byExternalProfileId byPageSize:byPageSize byPage:byPage completionHandler: ^(inline_response_200_1 output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var RecoEngineDev = require('reco_engine_dev');
var defaultClient = RecoEngineDev.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new RecoEngineDev.ProfilesApi()

var xApiKey = xApiKey_example; // {String} Client API Key

var clientId = clientId_example; // {String} Client Id. Each client will be provided with a clientId and an API Key

var opts = { 
  'byId': 56, // {Integer} Profile ID to be retrieved
You may also query the endpont using the parameter name id
'byExternalAccountId': byExternalAccountId_example, // {String} account id in the Client System
You may also query the endpont using the parameter name externalAccountId
'byExternalProfileId': byExternalProfileId_example, // {String} profile id in the Client System
You may also query the endpont using the parameter name externalProfileId
'byPageSize': 56, // {Integer} Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
'byPage': 56 // {Integer} Number of page
You may also query the endpont using the parameter name page
}; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getProfile(xApiKey, clientId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProfileExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new ProfilesApi();
            var xApiKey = xApiKey_example;  // String | Client API Key
            var clientId = clientId_example;  // String | Client Id. Each client will be provided with a clientId and an API Key
            var byId = 56;  // Integer | Profile ID to be retrieved
You may also query the endpont using the parameter name id
(optional) var byExternalAccountId = byExternalAccountId_example; // String | account id in the Client System
You may also query the endpont using the parameter name externalAccountId
(optional) var byExternalProfileId = byExternalProfileId_example; // String | profile id in the Client System
You may also query the endpont using the parameter name externalProfileId
(optional) var byPageSize = 56; // Integer | Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
(optional) var byPage = 56; // Integer | Number of page
You may also query the endpont using the parameter name page
(optional) try { // Get Profile inline_response_200_1 result = apiInstance.getProfile(xApiKey, clientId, byId, byExternalAccountId, byExternalProfileId, byPageSize, byPage); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling ProfilesApi.getProfile: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ProfilesApi();
$xApiKey = xApiKey_example; // String | Client API Key
$clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
$byId = 56; // Integer | Profile ID to be retrieved
You may also query the endpont using the parameter name id
$byExternalAccountId = byExternalAccountId_example; // String | account id in the Client System
You may also query the endpont using the parameter name externalAccountId
$byExternalProfileId = byExternalProfileId_example; // String | profile id in the Client System
You may also query the endpont using the parameter name externalProfileId
$byPageSize = 56; // Integer | Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
$byPage = 56; // Integer | Number of page
You may also query the endpont using the parameter name page
try { $result = $api_instance->getProfile($xApiKey, $clientId, $byId, $byExternalAccountId, $byExternalProfileId, $byPageSize, $byPage); print_r($result); } catch (Exception $e) { echo 'Exception when calling ProfilesApi->getProfile: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProfilesApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProfilesApi->new();
my $xApiKey = xApiKey_example; # String | Client API Key
my $clientId = clientId_example; # String | Client Id. Each client will be provided with a clientId and an API Key
my $byId = 56; # Integer | Profile ID to be retrieved
You may also query the endpont using the parameter name id
my $byExternalAccountId = byExternalAccountId_example; # String | account id in the Client System
You may also query the endpont using the parameter name externalAccountId
my $byExternalProfileId = byExternalProfileId_example; # String | profile id in the Client System
You may also query the endpont using the parameter name externalProfileId
my $byPageSize = 56; # Integer | Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
my $byPage = 56; # Integer | Number of page
You may also query the endpont using the parameter name page
eval { my $result = $api_instance->getProfile(xApiKey => $xApiKey, clientId => $clientId, byId => $byId, byExternalAccountId => $byExternalAccountId, byExternalProfileId => $byExternalProfileId, byPageSize => $byPageSize, byPage => $byPage); print Dumper($result); }; if ($@) { warn "Exception when calling ProfilesApi->getProfile: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProfilesApi()
xApiKey = xApiKey_example # String | Client API Key
clientId = clientId_example # String | Client Id. Each client will be provided with a clientId and an API Key
byId = 56 # Integer | Profile ID to be retrieved
You may also query the endpont using the parameter name id
(optional) byExternalAccountId = byExternalAccountId_example # String | account id in the Client System
You may also query the endpont using the parameter name externalAccountId
(optional) byExternalProfileId = byExternalProfileId_example # String | profile id in the Client System
You may also query the endpont using the parameter name externalProfileId
(optional) byPageSize = 56 # Integer | Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
(optional) byPage = 56 # Integer | Number of page
You may also query the endpont using the parameter name page
(optional) try: # Get Profile api_response = api_instance.get_profile(xApiKey, clientId, byId=byId, byExternalAccountId=byExternalAccountId, byExternalProfileId=byExternalProfileId, byPageSize=byPageSize, byPage=byPage) pprint(api_response) except ApiException as e: print("Exception when calling ProfilesApi->getProfile: %s\n" % e)

Parameters

Header parameters
Name Description
x-api-key*
String
Client API Key
Required
client-id*
String
Client Id. Each client will be provided with a clientId and an API Key
Required
Query parameters
Name Description
byId
Integer
Profile ID to be retrieved
You may also query the endpont using the parameter name id
byExternalAccountId
String
account id in the Client System
You may also query the endpont using the parameter name externalAccountId
byExternalProfileId
String
profile id in the Client System
You may also query the endpont using the parameter name externalProfileId
byPageSize
Integer
Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
byPage
Integer
Number of page
You may also query the endpont using the parameter name page

Responses

Status: 200 - Profile result

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 400 - Invalid Request

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 500 - Error Response

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 504 - Gateway Timeout

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

patchProfile

Patch Profile

Updates a user profile on the system


/v1/profile/{id}

Usage and SDK Samples

curl -X PATCH -H "x-api-key: [[apiKey]]" "https://recommendations.dive.tv/v1/profile/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProfilesApi;

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

public class ProfilesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ProfilesApi apiInstance = new ProfilesApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String id = id_example; // String | Profile ID to be patched
        Data_5 data = ; // Data_5 | form data
        try {
            array[Object] result = apiInstance.patchProfile(xApiKey, clientId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#patchProfile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProfilesApi;

public class ProfilesApiExample {

    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String id = id_example; // String | Profile ID to be patched
        Data_5 data = ; // Data_5 | form data
        try {
            array[Object] result = apiInstance.patchProfile(xApiKey, clientId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#patchProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *xApiKey = xApiKey_example; // Client API Key
String *clientId = clientId_example; // Client Id. Each client will be provided with a clientId and an API Key
String *id = id_example; // Profile ID to be patched
Data_5 *data = ; // form data (optional)

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

// Patch Profile
[apiInstance patchProfileWith:xApiKey
    clientId:clientId
    id:id
    data:data
              completionHandler: ^(array[Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecoEngineDev = require('reco_engine_dev');
var defaultClient = RecoEngineDev.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new RecoEngineDev.ProfilesApi()

var xApiKey = xApiKey_example; // {String} Client API Key

var clientId = clientId_example; // {String} Client Id. Each client will be provided with a clientId and an API Key

var id = id_example; // {String} Profile ID to be patched

var opts = { 
  'data':  // {Data_5} form data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchProfile(xApiKey, clientId, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchProfileExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new ProfilesApi();
            var xApiKey = xApiKey_example;  // String | Client API Key
            var clientId = clientId_example;  // String | Client Id. Each client will be provided with a clientId and an API Key
            var id = id_example;  // String | Profile ID to be patched
            var data = new Data_5(); // Data_5 | form data (optional) 

            try
            {
                // Patch Profile
                array[Object] result = apiInstance.patchProfile(xApiKey, clientId, id, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProfilesApi.patchProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ProfilesApi();
$xApiKey = xApiKey_example; // String | Client API Key
$clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
$id = id_example; // String | Profile ID to be patched
$data = ; // Data_5 | form data

try {
    $result = $api_instance->patchProfile($xApiKey, $clientId, $id, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfilesApi->patchProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProfilesApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProfilesApi->new();
my $xApiKey = xApiKey_example; # String | Client API Key
my $clientId = clientId_example; # String | Client Id. Each client will be provided with a clientId and an API Key
my $id = id_example; # String | Profile ID to be patched
my $data = WWW::SwaggerClient::Object::Data_5->new(); # Data_5 | form data

eval { 
    my $result = $api_instance->patchProfile(xApiKey => $xApiKey, clientId => $clientId, id => $id, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfilesApi->patchProfile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProfilesApi()
xApiKey = xApiKey_example # String | Client API Key
clientId = clientId_example # String | Client Id. Each client will be provided with a clientId and an API Key
id = id_example # String | Profile ID to be patched
data =  # Data_5 | form data (optional)

try: 
    # Patch Profile
    api_response = api_instance.patch_profile(xApiKey, clientId, id, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->patchProfile: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Profile ID to be patched
Required
Header parameters
Name Description
x-api-key*
String
Client API Key
Required
client-id*
String
Client Id. Each client will be provided with a clientId and an API Key
Required
Body parameters
Name Description
data

Responses

Status: 200 - Profile result

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 400 - Invalid Request

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 500 - Error Response

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 504 - Gateway Timeout

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

postProfile

Create Profile

Adds a new user profile to the system


/v1/profile

Usage and SDK Samples

curl -X POST -H "x-api-key: [[apiKey]]" "https://recommendations.dive.tv/v1/profile"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProfilesApi;

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

public class ProfilesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ProfilesApi apiInstance = new ProfilesApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        Data_4 data = ; // Data_4 | form data
        try {
            array[Object] result = apiInstance.postProfile(xApiKey, clientId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#postProfile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProfilesApi;

public class ProfilesApiExample {

    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        Data_4 data = ; // Data_4 | form data
        try {
            array[Object] result = apiInstance.postProfile(xApiKey, clientId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#postProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *xApiKey = xApiKey_example; // Client API Key
String *clientId = clientId_example; // Client Id. Each client will be provided with a clientId and an API Key
Data_4 *data = ; // form data (optional)

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

// Create Profile
[apiInstance postProfileWith:xApiKey
    clientId:clientId
    data:data
              completionHandler: ^(array[Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecoEngineDev = require('reco_engine_dev');
var defaultClient = RecoEngineDev.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new RecoEngineDev.ProfilesApi()

var xApiKey = xApiKey_example; // {String} Client API Key

var clientId = clientId_example; // {String} Client Id. Each client will be provided with a clientId and an API Key

var opts = { 
  'data':  // {Data_4} form data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postProfile(xApiKey, clientId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postProfileExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new ProfilesApi();
            var xApiKey = xApiKey_example;  // String | Client API Key
            var clientId = clientId_example;  // String | Client Id. Each client will be provided with a clientId and an API Key
            var data = new Data_4(); // Data_4 | form data (optional) 

            try
            {
                // Create Profile
                array[Object] result = apiInstance.postProfile(xApiKey, clientId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProfilesApi.postProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ProfilesApi();
$xApiKey = xApiKey_example; // String | Client API Key
$clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
$data = ; // Data_4 | form data

try {
    $result = $api_instance->postProfile($xApiKey, $clientId, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfilesApi->postProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProfilesApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProfilesApi->new();
my $xApiKey = xApiKey_example; # String | Client API Key
my $clientId = clientId_example; # String | Client Id. Each client will be provided with a clientId and an API Key
my $data = WWW::SwaggerClient::Object::Data_4->new(); # Data_4 | form data

eval { 
    my $result = $api_instance->postProfile(xApiKey => $xApiKey, clientId => $clientId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfilesApi->postProfile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProfilesApi()
xApiKey = xApiKey_example # String | Client API Key
clientId = clientId_example # String | Client Id. Each client will be provided with a clientId and an API Key
data =  # Data_4 | form data (optional)

try: 
    # Create Profile
    api_response = api_instance.post_profile(xApiKey, clientId, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->postProfile: %s\n" % e)

Parameters

Header parameters
Name Description
x-api-key*
String
Client API Key
Required
client-id*
String
Client Id. Each client will be provided with a clientId and an API Key
Required
Body parameters
Name Description
data

Responses

Status: 200 - Profile result

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 400 - Invalid Request

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 500 - Error Response

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 504 - Gateway Timeout

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Recommendations

getRecommendations

Gets recommendations

List the recommendations associated with a user profile


/v1/recommendations

Usage and SDK Samples

curl -X GET -H "x-api-key: [[apiKey]]" "https://recommendations.dive.tv/v1/recommendations?byExternalAccountProfileId=&byProfileCountry=&byDevice=&byMediaEventType=&byProgramType=&byMediaContentProviderId=&byPageSize=&byExclusivePageStart=&byTags=&byMovieId=&byCustomValue="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RecommendationsApi;

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

public class RecommendationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        RecommendationsApi apiInstance = new RecommendationsApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String byExternalAccountProfileId = byExternalAccountProfileId_example; // String | Allows to get the recommendations for a given profile account / profile.It must came in the form of externalAcoount$$$externalProfile
You may also query the endpont using the parameter name externalAccountProfileId
String byProfileCountry = byProfileCountry_example; // String | Filter recommendations by country
You may also query the endpont using the parameter name profileCountry
This argument is case insensitive
String byDevice = byDevice_example; // String | Filter recommendations by device type
You may also query the endpont using the parameter name device
This argument is case insensitive
String byMediaEventType = byMediaEventType_example; // String | Media Event Type in the Client System
You may also query the endpont using the parameter name mediaEventType
This argument is case insensitive
Only acept the values VOD,EPG
String byProgramType = byProgramType_example; // String | Content type to be queried. Valid options are 'Series' or 'Movies'
You may also query the endpont using the parameter name programType
This argument is case insensitive
Only acept the values Series,Movie
String byMediaContentProviderId = byMediaContentProviderId_example; // String | Content Provider Id to filter by
You may also query the endpont using the parameter name mediaContentProviderId
Integer byPageSize = 56; // Integer | Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
String byExclusivePageStart = byExclusivePageStart_example; // String | From where to start reading
You may also query the endpont using the parameter name exclusivePageStart
String byTags = byTags_example; // String | Recommendations that include these tags. Tag values must follow this syntax: tagname:value[,tagname1:value1|tagname2:value2...]. When expression ar concatenated by a comma (,) it's like a logical AND, if are concatenated by a pipe (|) it's a logical OR
You may also query the endpont using the parameter name tags
This argument is case insensitive
String byMovieId = byMovieId_example; // String | External movie id. Used to determine the more like this
You may also query the endpont using the parameter name movieId
String byCustomValue = byCustomValue_example; // String | To query by any value on the output. The format is {fieldname}[values] values can be separated by pipes (|)
You may also query the endpont using the parameter name customValue
try { inline_response_200_2 result = apiInstance.getRecommendations(xApiKey, clientId, byExternalAccountProfileId, byProfileCountry, byDevice, byMediaEventType, byProgramType, byMediaContentProviderId, byPageSize, byExclusivePageStart, byTags, byMovieId, byCustomValue); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RecommendationsApi#getRecommendations"); e.printStackTrace(); } } }
import io.swagger.client.api.RecommendationsApi;

public class RecommendationsApiExample {

    public static void main(String[] args) {
        RecommendationsApi apiInstance = new RecommendationsApi();
        String xApiKey = xApiKey_example; // String | Client API Key
        String clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
        String byExternalAccountProfileId = byExternalAccountProfileId_example; // String | Allows to get the recommendations for a given profile account / profile.It must came in the form of externalAcoount$$$externalProfile
You may also query the endpont using the parameter name externalAccountProfileId
String byProfileCountry = byProfileCountry_example; // String | Filter recommendations by country
You may also query the endpont using the parameter name profileCountry
This argument is case insensitive
String byDevice = byDevice_example; // String | Filter recommendations by device type
You may also query the endpont using the parameter name device
This argument is case insensitive
String byMediaEventType = byMediaEventType_example; // String | Media Event Type in the Client System
You may also query the endpont using the parameter name mediaEventType
This argument is case insensitive
Only acept the values VOD,EPG
String byProgramType = byProgramType_example; // String | Content type to be queried. Valid options are 'Series' or 'Movies'
You may also query the endpont using the parameter name programType
This argument is case insensitive
Only acept the values Series,Movie
String byMediaContentProviderId = byMediaContentProviderId_example; // String | Content Provider Id to filter by
You may also query the endpont using the parameter name mediaContentProviderId
Integer byPageSize = 56; // Integer | Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
String byExclusivePageStart = byExclusivePageStart_example; // String | From where to start reading
You may also query the endpont using the parameter name exclusivePageStart
String byTags = byTags_example; // String | Recommendations that include these tags. Tag values must follow this syntax: tagname:value[,tagname1:value1|tagname2:value2...]. When expression ar concatenated by a comma (,) it's like a logical AND, if are concatenated by a pipe (|) it's a logical OR
You may also query the endpont using the parameter name tags
This argument is case insensitive
String byMovieId = byMovieId_example; // String | External movie id. Used to determine the more like this
You may also query the endpont using the parameter name movieId
String byCustomValue = byCustomValue_example; // String | To query by any value on the output. The format is {fieldname}[values] values can be separated by pipes (|)
You may also query the endpont using the parameter name customValue
try { inline_response_200_2 result = apiInstance.getRecommendations(xApiKey, clientId, byExternalAccountProfileId, byProfileCountry, byDevice, byMediaEventType, byProgramType, byMediaContentProviderId, byPageSize, byExclusivePageStart, byTags, byMovieId, byCustomValue); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RecommendationsApi#getRecommendations"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *xApiKey = xApiKey_example; // Client API Key
String *clientId = clientId_example; // Client Id. Each client will be provided with a clientId and an API Key
String *byExternalAccountProfileId = byExternalAccountProfileId_example; // Allows to get the recommendations for a given profile account / profile.It must came in the form of externalAcoount$$$externalProfile
You may also query the endpont using the parameter name externalAccountProfileId
(optional) String *byProfileCountry = byProfileCountry_example; // Filter recommendations by country
You may also query the endpont using the parameter name profileCountry
This argument is case insensitive
(optional) String *byDevice = byDevice_example; // Filter recommendations by device type
You may also query the endpont using the parameter name device
This argument is case insensitive
(optional) String *byMediaEventType = byMediaEventType_example; // Media Event Type in the Client System
You may also query the endpont using the parameter name mediaEventType
This argument is case insensitive
Only acept the values VOD,EPG
(optional) String *byProgramType = byProgramType_example; // Content type to be queried. Valid options are 'Series' or 'Movies'
You may also query the endpont using the parameter name programType
This argument is case insensitive
Only acept the values Series,Movie
(optional) String *byMediaContentProviderId = byMediaContentProviderId_example; // Content Provider Id to filter by
You may also query the endpont using the parameter name mediaContentProviderId
(optional) Integer *byPageSize = 56; // Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
(optional) String *byExclusivePageStart = byExclusivePageStart_example; // From where to start reading
You may also query the endpont using the parameter name exclusivePageStart
(optional) String *byTags = byTags_example; // Recommendations that include these tags. Tag values must follow this syntax: tagname:value[,tagname1:value1|tagname2:value2...]. When expression ar concatenated by a comma (,) it's like a logical AND, if are concatenated by a pipe (|) it's a logical OR
You may also query the endpont using the parameter name tags
This argument is case insensitive
(optional) String *byMovieId = byMovieId_example; // External movie id. Used to determine the more like this
You may also query the endpont using the parameter name movieId
(optional) String *byCustomValue = byCustomValue_example; // To query by any value on the output. The format is {fieldname}[values] values can be separated by pipes (|)
You may also query the endpont using the parameter name customValue
(optional) RecommendationsApi *apiInstance = [[RecommendationsApi alloc] init]; // Gets recommendations [apiInstance getRecommendationsWith:xApiKey clientId:clientId byExternalAccountProfileId:byExternalAccountProfileId byProfileCountry:byProfileCountry byDevice:byDevice byMediaEventType:byMediaEventType byProgramType:byProgramType byMediaContentProviderId:byMediaContentProviderId byPageSize:byPageSize byExclusivePageStart:byExclusivePageStart byTags:byTags byMovieId:byMovieId byCustomValue:byCustomValue completionHandler: ^(inline_response_200_2 output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var RecoEngineDev = require('reco_engine_dev');
var defaultClient = RecoEngineDev.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new RecoEngineDev.RecommendationsApi()

var xApiKey = xApiKey_example; // {String} Client API Key

var clientId = clientId_example; // {String} Client Id. Each client will be provided with a clientId and an API Key

var opts = { 
  'byExternalAccountProfileId': byExternalAccountProfileId_example, // {String} Allows to get the recommendations for a given profile account / profile.It must came in the form of externalAcoount$$$externalProfile
You may also query the endpont using the parameter name externalAccountProfileId
'byProfileCountry': byProfileCountry_example, // {String} Filter recommendations by country
You may also query the endpont using the parameter name profileCountry
This argument is case insensitive
'byDevice': byDevice_example, // {String} Filter recommendations by device type
You may also query the endpont using the parameter name device
This argument is case insensitive
'byMediaEventType': byMediaEventType_example, // {String} Media Event Type in the Client System
You may also query the endpont using the parameter name mediaEventType
This argument is case insensitive
Only acept the values VOD,EPG
'byProgramType': byProgramType_example, // {String} Content type to be queried. Valid options are 'Series' or 'Movies'
You may also query the endpont using the parameter name programType
This argument is case insensitive
Only acept the values Series,Movie
'byMediaContentProviderId': byMediaContentProviderId_example, // {String} Content Provider Id to filter by
You may also query the endpont using the parameter name mediaContentProviderId
'byPageSize': 56, // {Integer} Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
'byExclusivePageStart': byExclusivePageStart_example, // {String} From where to start reading
You may also query the endpont using the parameter name exclusivePageStart
'byTags': byTags_example, // {String} Recommendations that include these tags. Tag values must follow this syntax: tagname:value[,tagname1:value1|tagname2:value2...]. When expression ar concatenated by a comma (,) it's like a logical AND, if are concatenated by a pipe (|) it's a logical OR
You may also query the endpont using the parameter name tags
This argument is case insensitive
'byMovieId': byMovieId_example, // {String} External movie id. Used to determine the more like this
You may also query the endpont using the parameter name movieId
'byCustomValue': byCustomValue_example // {String} To query by any value on the output. The format is {fieldname}[values] values can be separated by pipes (|)
You may also query the endpont using the parameter name customValue
}; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getRecommendations(xApiKey, clientId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRecommendationsExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new RecommendationsApi();
            var xApiKey = xApiKey_example;  // String | Client API Key
            var clientId = clientId_example;  // String | Client Id. Each client will be provided with a clientId and an API Key
            var byExternalAccountProfileId = byExternalAccountProfileId_example;  // String | Allows to get the recommendations for a given profile account / profile.It must came in the form of externalAcoount$$$externalProfile
You may also query the endpont using the parameter name externalAccountProfileId
(optional) var byProfileCountry = byProfileCountry_example; // String | Filter recommendations by country
You may also query the endpont using the parameter name profileCountry
This argument is case insensitive
(optional) var byDevice = byDevice_example; // String | Filter recommendations by device type
You may also query the endpont using the parameter name device
This argument is case insensitive
(optional) var byMediaEventType = byMediaEventType_example; // String | Media Event Type in the Client System
You may also query the endpont using the parameter name mediaEventType
This argument is case insensitive
Only acept the values VOD,EPG
(optional) var byProgramType = byProgramType_example; // String | Content type to be queried. Valid options are 'Series' or 'Movies'
You may also query the endpont using the parameter name programType
This argument is case insensitive
Only acept the values Series,Movie
(optional) var byMediaContentProviderId = byMediaContentProviderId_example; // String | Content Provider Id to filter by
You may also query the endpont using the parameter name mediaContentProviderId
(optional) var byPageSize = 56; // Integer | Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
(optional) var byExclusivePageStart = byExclusivePageStart_example; // String | From where to start reading
You may also query the endpont using the parameter name exclusivePageStart
(optional) var byTags = byTags_example; // String | Recommendations that include these tags. Tag values must follow this syntax: tagname:value[,tagname1:value1|tagname2:value2...]. When expression ar concatenated by a comma (,) it's like a logical AND, if are concatenated by a pipe (|) it's a logical OR
You may also query the endpont using the parameter name tags
This argument is case insensitive
(optional) var byMovieId = byMovieId_example; // String | External movie id. Used to determine the more like this
You may also query the endpont using the parameter name movieId
(optional) var byCustomValue = byCustomValue_example; // String | To query by any value on the output. The format is {fieldname}[values] values can be separated by pipes (|)
You may also query the endpont using the parameter name customValue
(optional) try { // Gets recommendations inline_response_200_2 result = apiInstance.getRecommendations(xApiKey, clientId, byExternalAccountProfileId, byProfileCountry, byDevice, byMediaEventType, byProgramType, byMediaContentProviderId, byPageSize, byExclusivePageStart, byTags, byMovieId, byCustomValue); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling RecommendationsApi.getRecommendations: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\RecommendationsApi();
$xApiKey = xApiKey_example; // String | Client API Key
$clientId = clientId_example; // String | Client Id. Each client will be provided with a clientId and an API Key
$byExternalAccountProfileId = byExternalAccountProfileId_example; // String | Allows to get the recommendations for a given profile account / profile.It must came in the form of externalAcoount$$$externalProfile
You may also query the endpont using the parameter name externalAccountProfileId
$byProfileCountry = byProfileCountry_example; // String | Filter recommendations by country
You may also query the endpont using the parameter name profileCountry
This argument is case insensitive
$byDevice = byDevice_example; // String | Filter recommendations by device type
You may also query the endpont using the parameter name device
This argument is case insensitive
$byMediaEventType = byMediaEventType_example; // String | Media Event Type in the Client System
You may also query the endpont using the parameter name mediaEventType
This argument is case insensitive
Only acept the values VOD,EPG
$byProgramType = byProgramType_example; // String | Content type to be queried. Valid options are 'Series' or 'Movies'
You may also query the endpont using the parameter name programType
This argument is case insensitive
Only acept the values Series,Movie
$byMediaContentProviderId = byMediaContentProviderId_example; // String | Content Provider Id to filter by
You may also query the endpont using the parameter name mediaContentProviderId
$byPageSize = 56; // Integer | Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
$byExclusivePageStart = byExclusivePageStart_example; // String | From where to start reading
You may also query the endpont using the parameter name exclusivePageStart
$byTags = byTags_example; // String | Recommendations that include these tags. Tag values must follow this syntax: tagname:value[,tagname1:value1|tagname2:value2...]. When expression ar concatenated by a comma (,) it's like a logical AND, if are concatenated by a pipe (|) it's a logical OR
You may also query the endpont using the parameter name tags
This argument is case insensitive
$byMovieId = byMovieId_example; // String | External movie id. Used to determine the more like this
You may also query the endpont using the parameter name movieId
$byCustomValue = byCustomValue_example; // String | To query by any value on the output. The format is {fieldname}[values] values can be separated by pipes (|)
You may also query the endpont using the parameter name customValue
try { $result = $api_instance->getRecommendations($xApiKey, $clientId, $byExternalAccountProfileId, $byProfileCountry, $byDevice, $byMediaEventType, $byProgramType, $byMediaContentProviderId, $byPageSize, $byExclusivePageStart, $byTags, $byMovieId, $byCustomValue); print_r($result); } catch (Exception $e) { echo 'Exception when calling RecommendationsApi->getRecommendations: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RecommendationsApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RecommendationsApi->new();
my $xApiKey = xApiKey_example; # String | Client API Key
my $clientId = clientId_example; # String | Client Id. Each client will be provided with a clientId and an API Key
my $byExternalAccountProfileId = byExternalAccountProfileId_example; # String | Allows to get the recommendations for a given profile account / profile.It must came in the form of externalAcoount$$$externalProfile
You may also query the endpont using the parameter name externalAccountProfileId
my $byProfileCountry = byProfileCountry_example; # String | Filter recommendations by country
You may also query the endpont using the parameter name profileCountry
This argument is case insensitive
my $byDevice = byDevice_example; # String | Filter recommendations by device type
You may also query the endpont using the parameter name device
This argument is case insensitive
my $byMediaEventType = byMediaEventType_example; # String | Media Event Type in the Client System
You may also query the endpont using the parameter name mediaEventType
This argument is case insensitive
Only acept the values VOD,EPG
my $byProgramType = byProgramType_example; # String | Content type to be queried. Valid options are 'Series' or 'Movies'
You may also query the endpont using the parameter name programType
This argument is case insensitive
Only acept the values Series,Movie
my $byMediaContentProviderId = byMediaContentProviderId_example; # String | Content Provider Id to filter by
You may also query the endpont using the parameter name mediaContentProviderId
my $byPageSize = 56; # Integer | Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
my $byExclusivePageStart = byExclusivePageStart_example; # String | From where to start reading
You may also query the endpont using the parameter name exclusivePageStart
my $byTags = byTags_example; # String | Recommendations that include these tags. Tag values must follow this syntax: tagname:value[,tagname1:value1|tagname2:value2...]. When expression ar concatenated by a comma (,) it's like a logical AND, if are concatenated by a pipe (|) it's a logical OR
You may also query the endpont using the parameter name tags
This argument is case insensitive
my $byMovieId = byMovieId_example; # String | External movie id. Used to determine the more like this
You may also query the endpont using the parameter name movieId
my $byCustomValue = byCustomValue_example; # String | To query by any value on the output. The format is {fieldname}[values] values can be separated by pipes (|)
You may also query the endpont using the parameter name customValue
eval { my $result = $api_instance->getRecommendations(xApiKey => $xApiKey, clientId => $clientId, byExternalAccountProfileId => $byExternalAccountProfileId, byProfileCountry => $byProfileCountry, byDevice => $byDevice, byMediaEventType => $byMediaEventType, byProgramType => $byProgramType, byMediaContentProviderId => $byMediaContentProviderId, byPageSize => $byPageSize, byExclusivePageStart => $byExclusivePageStart, byTags => $byTags, byMovieId => $byMovieId, byCustomValue => $byCustomValue); print Dumper($result); }; if ($@) { warn "Exception when calling RecommendationsApi->getRecommendations: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.RecommendationsApi()
xApiKey = xApiKey_example # String | Client API Key
clientId = clientId_example # String | Client Id. Each client will be provided with a clientId and an API Key
byExternalAccountProfileId = byExternalAccountProfileId_example # String | Allows to get the recommendations for a given profile account / profile.It must came in the form of externalAcoount$$$externalProfile
You may also query the endpont using the parameter name externalAccountProfileId
(optional) byProfileCountry = byProfileCountry_example # String | Filter recommendations by country
You may also query the endpont using the parameter name profileCountry
This argument is case insensitive
(optional) byDevice = byDevice_example # String | Filter recommendations by device type
You may also query the endpont using the parameter name device
This argument is case insensitive
(optional) byMediaEventType = byMediaEventType_example # String | Media Event Type in the Client System
You may also query the endpont using the parameter name mediaEventType
This argument is case insensitive
Only acept the values VOD,EPG
(optional) byProgramType = byProgramType_example # String | Content type to be queried. Valid options are 'Series' or 'Movies'
You may also query the endpont using the parameter name programType
This argument is case insensitive
Only acept the values Series,Movie
(optional) byMediaContentProviderId = byMediaContentProviderId_example # String | Content Provider Id to filter by
You may also query the endpont using the parameter name mediaContentProviderId
(optional) byPageSize = 56 # Integer | Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
(optional) byExclusivePageStart = byExclusivePageStart_example # String | From where to start reading
You may also query the endpont using the parameter name exclusivePageStart
(optional) byTags = byTags_example # String | Recommendations that include these tags. Tag values must follow this syntax: tagname:value[,tagname1:value1|tagname2:value2...]. When expression ar concatenated by a comma (,) it's like a logical AND, if are concatenated by a pipe (|) it's a logical OR
You may also query the endpont using the parameter name tags
This argument is case insensitive
(optional) byMovieId = byMovieId_example # String | External movie id. Used to determine the more like this
You may also query the endpont using the parameter name movieId
(optional) byCustomValue = byCustomValue_example # String | To query by any value on the output. The format is {fieldname}[values] values can be separated by pipes (|)
You may also query the endpont using the parameter name customValue
(optional) try: # Gets recommendations api_response = api_instance.get_recommendations(xApiKey, clientId, byExternalAccountProfileId=byExternalAccountProfileId, byProfileCountry=byProfileCountry, byDevice=byDevice, byMediaEventType=byMediaEventType, byProgramType=byProgramType, byMediaContentProviderId=byMediaContentProviderId, byPageSize=byPageSize, byExclusivePageStart=byExclusivePageStart, byTags=byTags, byMovieId=byMovieId, byCustomValue=byCustomValue) pprint(api_response) except ApiException as e: print("Exception when calling RecommendationsApi->getRecommendations: %s\n" % e)

Parameters

Header parameters
Name Description
x-api-key*
String
Client API Key
Required
client-id*
String
Client Id. Each client will be provided with a clientId and an API Key
Required
Query parameters
Name Description
byExternalAccountProfileId
String
Allows to get the recommendations for a given profile account / profile.It must came in the form of externalAcoount$$$externalProfile
You may also query the endpont using the parameter name externalAccountProfileId
byProfileCountry
String
Filter recommendations by country
You may also query the endpont using the parameter name profileCountry
This argument is case insensitive
byDevice
String
Filter recommendations by device type
You may also query the endpont using the parameter name device
This argument is case insensitive
byMediaEventType
String
Media Event Type in the Client System
You may also query the endpont using the parameter name mediaEventType
This argument is case insensitive
Only acept the values VOD,EPG
byProgramType
String
Content type to be queried. Valid options are 'Series' or 'Movies'
You may also query the endpont using the parameter name programType
This argument is case insensitive
Only acept the values Series,Movie
byMediaContentProviderId
String
Content Provider Id to filter by
You may also query the endpont using the parameter name mediaContentProviderId
byPageSize
Integer
Number of users returned. Max 50
You may also query the endpont using the parameter name pageSize
byExclusivePageStart
String
From where to start reading
You may also query the endpont using the parameter name exclusivePageStart
byTags
String
Recommendations that include these tags. Tag values must follow this syntax: tagname:value[,tagname1:value1|tagname2:value2...]. When expression ar concatenated by a comma (,) it's like a logical AND, if are concatenated by a pipe (|) it's a logical OR
You may also query the endpont using the parameter name tags
This argument is case insensitive
byMovieId
String
External movie id. Used to determine the more like this
You may also query the endpont using the parameter name movieId
byCustomValue
String
To query by any value on the output. The format is {fieldname}[values] values can be separated by pipes (|)
You may also query the endpont using the parameter name customValue

Responses

Status: 200 - Success Response

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 400 - Invalid Request

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 500 - Error Response

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String

Status: 504 - Gateway Timeout

Name Type Format Description
Content-Type String
Access-Control-Allow-Headers String
Access-Control-Allow-Methods String
Access-Control-Allow-Origin String