PROFILE BASED SERVICES

PROFILE BASED SERVICES (2.0.0)

Download OpenAPI specification:Download

Personalized recommendations based on the user's history.

Authentication

APIKeyQueryParam

Security Scheme Type	API Key
Query parameter name:	apikey

TASTE PROFILE

Weighted and categorized keywords reflecting topics of potential interest for every individual user.

USER SEMANTIC FINGERPRINT

Based on the user's history of interactions with content, the USF is a reflection of the user's favorite topics. Weighted keywords display the user's preferences providing full information on every user's taste.

Authorizations:

APIKeyQueryParam

path Parameters

user

required

string

Provide the user Id. Example: John - The user id must be provided in UTF-8 standard

Responses

Response samples

Content type

application/json


{"userId": "{UserId}",
"keywords": 
[
{"id": "102",
"display": "twisty",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 65,
"displayable": true
},
{"id": "392",
"display": "heroic fantasy",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 50,
"displayable": true
},
{"id": "210",
"display": "quirky",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 50,
"displayable": true
},
{"id": "299",
"display": "strange",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 50,
"displayable": true
},
{"id": "674",
"display": "laughs",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 50,
"displayable": true
},
{"id": "1152",
"display": "fantasy",
"category": 
{"id": "6",
"display": "Format"
},
"weight": 50,
"displayable": true
},
{"id": "360",
"display": "slapstick",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 50,
"displayable": true
},
{"id": "581",
"display": "parodies",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 50,
"displayable": true
},
{"id": "469",
"display": "fantasy",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 50,
"displayable": true
},
{"id": "405",
"display": "absurdist humor",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 50,
"displayable": true
},
{"id": "549",
"display": "myths",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 50,
"displayable": true
},
{"id": "409",
"display": "dark humor",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 50,
"displayable": true
},
{"id": "129",
"display": "mind-bender",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 47,
"displayable": true
},
{"id": "694",
"display": "saving the world",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 42,
"displayable": true
},
{"id": "26",
"display": "friends",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 40,
"displayable": true
},
{"id": "769",
"display": "superpowers",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 39,
"displayable": true
},
{"id": "161",
"display": "fistfights",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 35,
"displayable": true
},
{"id": "460",
"display": "history",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 35,
"displayable": true
},
{"id": "608",
"display": "spectacular",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 35,
"displayable": true
},
{"id": "297",
"display": "team spirit",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 30,
"displayable": true
},
{"id": "777",
"display": "suspense",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 30,
"displayable": true
},
{"id": "638",
"display": "quests",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 30,
"displayable": true
},
{"id": "506",
"display": "mentors",
"category": 
{"id": "3",
"display": "Character"
},
"weight": 30,
"displayable": true
},
{"id": "295",
"display": "hope",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 25,
"displayable": true
},
{"id": "358",
"display": "dystopia",
"category": 
{"id": "5",
"display": "Time period"
},
"weight": 25,
"displayable": true
},
{"id": "837",
"display": "violence",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 25,
"displayable": true
},
{"id": "519",
"display": "virtual reality",
"category": 
{"id": "4",
"display": "Setting"
},
"weight": 25,
"displayable": true
},
{"id": "1154",
"display": "action",
"category": 
{"id": "6",
"display": "Format"
},
"weight": 25,
"displayable": true
},
{"id": "1153",
"display": "adventure",
"category": 
{"id": "6",
"display": "Format"
},
"weight": 25,
"displayable": true
},
{"id": "1151",
"display": "science fiction",
"category": 
{"id": "6",
"display": "Format"
},
"weight": 25,
"displayable": true
},
{"id": "187",
"display": "period pieces",
"category": 
{"id": "5",
"display": "Time period"
},
"weight": 25,
"displayable": true
},
{"id": "720",
"display": "British fictions",
"category": 
{"id": "6",
"display": "Format"
},
"weight": 25,
"displayable": true
},
{"id": "887",
"display": "1970's movies and TV shows",
"category": 
{"id": "6",
"display": "Format"
},
"weight": 25,
"displayable": true
},
{"id": "525",
"display": "Middle Ages",
"category": 
{"id": "5",
"display": "Time period"
},
"weight": 25,
"displayable": true
},
{"id": "272",
"display": "music",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 20,
"displayable": true
},
{"id": "266",
"display": "family",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 15,
"displayable": true
},
{"id": "23",
"display": "dark atmosphere",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 9,
"displayable": true
},
{"id": "29",
"display": "action romance",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 9,
"displayable": true
},
{"id": "795",
"display": "religious themes",
"category": 
{"id": "2",
"display": "Theme"
},
"weight": 9,
"displayable": true
},
{"id": "312",
"display": "royalty",
"category": 
{"id": "3",
"display": "Character"
},
"weight": 9,
"displayable": true
},
{"id": "136",
"display": "new horizons",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 5,
"displayable": true
},
{"id": "680",
"display": "romance",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 5,
"displayable": true
},
{"id": "765",
"display": "creepy",
"category": 
{"id": "1",
"display": "Mood"
},
"weight": 5,
"displayable": true
}
]
}

RECOMMENDED FOR YOU

Real-time and time-based personalized suggestions based on the user's history of interactions.

PROFILE BASED RECOMMENDATION

Display profile-based suggestions presented in a Top N list mode in relevance order. Recommendations are calculated from the user's history of interactions.

Authorizations:

APIKeyQueryParam

path Parameters

user

required

string

Provide the user Id. Example: John - The user id must be provided in UTF-8 standard

universes

required

Array of strings

Items Enum: "vod" "now" "today" "tonight" "later_tonight" "week" "catchup"

This parameter defines the content universe in which we want to target content recommendations. If you want to call several universes, you have to separate each of them by a comma (,). "Available universes are:" "vod" "catchup" "For tv recommendations one of the following values should be chosen:" "'now', 'today', 'tonight', 'later_tonight' or 'week'"

query Parameters

device	string Define the platform on which the interactions occurred. This can be helpful to identify discrepancies in usage between platforms like TV, tablet, web, mobile apps.
details	boolean You can choose to display your meta-data in order to save precious response time. By default this parameter is marked "false", details are not automatically shown. To show details, you have to ask for "true".
skip	integer You can use this parameter to skip the first results that would be displayed. For example: skip=5 means not showing the first 5 results. Default value=0
limit	integer Number of results requested (max.100). The default value=10
displaysize	boolean You can choose to display the total number of results by using "true". The default value= false
sections	string If you want to restrict the recommendations to a specific section, you can pass the section code as a value to this parameter.
language	string Enum: "br" "de" "en" "fr" "id" "ms" "ph" "pt" "es" "th" Language in which the metadata is displayed: en - english (default) fr - french de - german br - brazilian portuguese es - spanish id - indonesian ms - malay ph - filipino *th - thai
genres	string Filter the results according to one or several genres.
catalogs	string Define your choice of catalog names, in case you have multiple catalogs, on which recommendations are applied, separated by a comma (,).
tabs	string If your platform's interface is divided into separate sections or tabs for specific content 'groups', you can filter the recommendation for each section with this 'tab' parameter. In order to use this parameter, you must provide information about these specific content sections on your platform to Spideo beforehand and separate each tab by a comma (,).
territories	string If your platform is available in multiple countries and/or territories, this parameter allows to filter the recommendation results based on these territories. In order to use this parameter you must provide Spideo with the territory rights for each piece of content, within the catalog import process, and indicate for each content item to which territory it belongs.
distributions	integer "If your platform is available with several distributions business models, this parameter allows to filter the recommendation results based on these distributions. In order to use this parameter you must provide Spideo with the distributions rights for each piece of content, within the catalog import process, and indicate for each content item to which distribution it belongs.Example:TVOD, SVOD, AVOD
offers	integer "This parameter allows you to filter recommendations results to only provide suggestions on programs available in the user's offers subscribtions. In order to use this parameter you must provide Spideo with the offers rights for each channel, catchup store or VOD catalog.
platform	integer This parameter allows you to filter the recommendations results on the platforms on which the content are available. In order to use this parameter you must provide Spideo with the platform rights for each piece of content, within the catalog import process, and indicate for each content item to which pltaform it belongs. Example of values that can be configured:stb, ios, android.
infrastructure	integer "This parameter allows you to filter the recommendations results on the infrastructures on which the content are available. In order to use this parameter you must provide Spideo with the infrastructure rights for each piece of content, within the catalog import process, and indicate for each content item to which infrastructure it belongs. Example of values that can be configured: FTTH, FTTB, ADSL.
operator	integer "This parameter allows you to filter the recommendations results on the operators on which the content are available. In order to use this parameter you must provide Spideo with the operator rights for each channel, catchup store or VOD catalog.
lineups	string This parameter allows you to filter the recommendations results on a group of TV channels defined under a lineup id.
channel	string When the Business Rules Network Restrictions is activated recommendations can be filtered on group of channels. This parameter needs to be added to the recommendation calls to identify for each channel on which group it belongs. When a channel id is entered with this parameter, recommendations will only be provided on the channels linked to the same media group. List of channels by id, separated by a comma (,)Screen reader support enabled.
channels	string This parameter allows you to filter the recommendations results to only provide results on the channels listed in this parameter. List of channels by id, separated by a comma (,)
recency	integer "If you want to restrict recommendation only to recent content you can use this parameter. As a value pass the number of months a content item can be recommended after having been added to the catalog. It can for example be based on publication dates. For instance: recency=5 means not showing content that has a publication date >5 months. The default value=0"

Responses

Response samples

Content type

application/json


{"user": "{UserId}",
"language": "en",
"recordsAllowed": true,
"recommendation": 
{"size": 20,
"contents": 
[
{"id": "M1346850000",
"title": "The Matrix Reloaded",
"externalIds": 
{"TMDB": "604",
"IMDb": "tt0234215"
},
"type": "VOD"
},
{"id": "M9352300000",
"title": "Ghost in the Shell",
"externalIds": 
{"TMDB": "315837",
"IMDb": "tt1219827"
},
"type": "VOD"
},
{"id": "M2657630000",
"title": "Ghost in the Shell 2.0",
"externalIds": 
{"TMDB": "9323",
"IMDb": "tt0113568"
},
"type": "VOD"
},
{"id": "M276590000",
"title": "Erik the Viking",
"externalIds": 
{"TMDB": "11828",
"IMDb": "tt0097289"
},
"type": "VOD"
},
{"id": "M1357670000",
"title": "Pirates of the Caribbean: The Curse of the Black Pearl",
"externalIds": 
{"TMDB": "22",
"IMDb": "tt0325980"
},
"type": "VOD"
},
{"id": "M8035730000",
"title": "Monster Hunt",
"externalIds": 
{"TMDB": "334298",
"IMDb": "tt3781476"
},
"type": "VOD"
},
{"id": "M2080640000",
"title": "The Dark Knight",
"externalIds": 
{"TMDB": "155",
"IMDb": "tt0468569"
},
"type": "VOD"
},
{"id": "M206880000",
"title": "Aliens",
"externalIds": 
{"TMDB": "679",
"IMDb": "tt0090605"
},
"type": "VOD"
},
{"id": "M160240000",
"title": "The Terminator",
"externalIds": 
{"TMDB": "218",
"IMDb": "tt0088247"
},
"type": "VOD"
},
{"id": "M2527820000",
"title": "Prince of Persia: The Sands of Time",
"externalIds": 
{"TMDB": "9543",
"IMDb": "tt0473075"
},
"type": "VOD"
},
{"id": "S13439310000",
"title": "Xena",
"externalIds": 
{"TMDB": "4616",
"IMDb": "tt0112230"
},
"type": "VOD"
},
{"id": "M745520000",
"title": "Fight Club",
"externalIds": 
{"TMDB": "550",
"IMDb": "tt0137523"
},
"type": "VOD"
},
{"id": "M376520000",
"title": "Demolition Man",
"externalIds": 
{"TMDB": "9739",
"IMDb": "tt0106697"
},
"type": "VOD"
},
{"id": "S2131100000",
"title": "Buffy the Vampire Slayer",
"externalIds": 
{"TMDB": "95",
"IMDb": "tt0118276"
},
"type": "VOD"
},
{"id": "M119130000",
"title": "Eraserhead",
"externalIds": 
{"TMDB": "985",
"IMDb": "tt0074486"
},
"type": "VOD"
},
{"id": "S625840000",
"title": "Twin Peaks",
"externalIds": 
{"TMDB": "1920",
"IMDb": "tt0098936"
},
"type": "VOD"
},
{"id": "M350760000",
"title": "Twin Peaks: Fire Walk With Me",
"externalIds": 
{"TMDB": "1923",
"IMDb": "tt0105665"
},
"type": "VOD"
},
{"id": "M1836750000",
"title": "The Last Legion",
"externalIds": 
{"TMDB": "9703",
"IMDb": "tt0462396"
},
"type": "VOD"
},
{"id": "M1345500000",
"title": "X2",
"externalIds": 
{"TMDB": "36658",
"IMDb": "tt0290334"
},
"type": "VOD"
},
{"id": "M1472530000",
"title": "Cypher",
"externalIds": 
{"TMDB": "10133",
"IMDb": "tt0284978"
},
"type": "VOD"
}
],
"type": "vod"
}
}

SEMANTIC PERSONALIZATION

Personalized suggestions explained by thematic lists corresponding to clusters of keywords relevant to users.

CATEGORIZED RECOMMENDATIONS

Display thematically organized playlists of profile-based suggestions. Recommended content items are presented in groups of categories made up of combinations of two keywords corresponding to every user's tastes. Natural language based explanations help people engage with content in a more intuitive discovery experience.

Authorizations:

APIKeyQueryParam

path Parameters

user

required

string

Provide the user Id. Example: John - The user id must be provided in UTF-8 standard

universes

required

Array of strings

Items Enum: "vod" "now" "today" "tonight" "later_tonight" "week" "catchup"

query Parameters

device	string Define the platform on which the interactions occurred. This can be helpful to identify discrepancies in usage between platforms like TV, tablet, web, mobile apps.
details	boolean You can choose to display your meta-data in order to save precious response time. By default this parameter is marked "false", details are not automatically shown. To show details, you have to ask for "true".
skip	integer You can use this parameter to skip the first results that would be displayed. For example: skip=5 means not showing the first 5 results. Default value=0
limit	integer Number of results requested (max.100). The default value=10
displaysize	boolean You can choose to display the total number of results by using "true". The default value= false
sections	string If you want to restrict the recommendations to a specific section, you can pass the section code as a value to this parameter.
language	string Enum: "br" "de" "en" "fr" "id" "ms" "ph" "pt" "es" "th" Language in which the metadata is displayed: en - english (default) fr - french de - german br - brazilian portuguese es - spanish id - indonesian ms - malay ph - filipino *th - thai
catalogs	string Define your choice of catalog names, in case you have multiple catalogs, on which recommendations are applied, separated by a comma (,).
tabs	string If your platform's interface is divided into separate sections or tabs for specific content 'groups', you can filter the recommendation for each section with this 'tab' parameter. In order to use this parameter, you must provide information about these specific content sections on your platform to Spideo beforehand and separate each tab by a comma (,).
territories	string If your platform is available in multiple countries and/or territories, this parameter allows to filter the recommendation results based on these territories. In order to use this parameter you must provide Spideo with the territory rights for each piece of content, within the catalog import process, and indicate for each content item to which territory it belongs.
distributions	integer "If your platform is available with several distributions business models, this parameter allows to filter the recommendation results based on these distributions. In order to use this parameter you must provide Spideo with the distributions rights for each piece of content, within the catalog import process, and indicate for each content item to which distribution it belongs.Example:TVOD, SVOD, AVOD
offers	integer "This parameter allows you to filter recommendations results to only provide suggestions on programs available in the user's offers subscribtions. In order to use this parameter you must provide Spideo with the offers rights for each channel, catchup store or VOD catalog.
platform	integer This parameter allows you to filter the recommendations results on the platforms on which the content are available. In order to use this parameter you must provide Spideo with the platform rights for each piece of content, within the catalog import process, and indicate for each content item to which pltaform it belongs. Example of values that can be configured:stb, ios, android.
infrastructure	integer "This parameter allows you to filter the recommendations results on the infrastructures on which the content are available. In order to use this parameter you must provide Spideo with the infrastructure rights for each piece of content, within the catalog import process, and indicate for each content item to which infrastructure it belongs. Example of values that can be configured: FTTH, FTTB, ADSL.
operator	integer "This parameter allows you to filter the recommendations results on the operators on which the content are available. In order to use this parameter you must provide Spideo with the operator rights for each channel, catchup store or VOD catalog.
lineups	string This parameter allows you to filter the recommendations results on a group of TV channels defined under a lineup id.
channel	string When the Business Rules Network Restrictions is activated recommendations can be filtered on group of channels. This parameter needs to be added to the recommendation calls to identify for each channel on which group it belongs. When a channel id is entered with this parameter, recommendations will only be provided on the channels linked to the same media group. List of channels by id, separated by a comma (,)Screen reader support enabled.
channels	string This parameter allows you to filter the recommendations results to only provide results on the channels listed in this parameter. List of channels by id, separated by a comma (,)
recency	integer If you want to restrict recommendation only to recent content you can use this parameter. As a value pass the number of months a content item can be recommended after having been added to the catalog. It can for example be based on publication dates. For instance: recency=5 means not showing content that has a publication date >5 months. The default value=0"

Responses

Response samples

Content type

application/json


{"user": "{UserId}",
"recordsAllowed": true,
"categories": 
[
{"size": 10,
"contents": 
[
{"id": "M1346850000",
"title": "The Matrix Reloaded",
"externalIds": 
{"TMDB": "604",
"IMDb": "tt0234215"
},
"type": "VOD"
},
{"id": "M9352300000",
"title": "Ghost in the Shell",
"externalIds": 
{"TMDB": "315837",
"IMDb": "tt1219827"
},
"type": "VOD"
},
{"id": "M2657630000",
"title": "Ghost in the Shell 2.0",
"externalIds": 
{"TMDB": "9323",
"IMDb": "tt0113568"
},
"type": "VOD"
},
{"id": "M2261520000",
"title": "Gamer",
"externalIds": 
{"TMDB": "18501",
"IMDb": "tt1034032"
},
"type": "VOD"
},
{"id": "M3903890000",
"title": "Resident Evil: Retribution",
"externalIds": 
{"TMDB": "71679",
"IMDb": "tt1855325"
},
"type": "VOD"
},
{"id": "M346710000",
"title": "The Lawnmower Man",
"externalIds": 
{"TMDB": "10163",
"IMDb": "tt0104692"
},
"type": "VOD"
},
{"id": "M1891980000",
"title": "Paprika",
"externalIds": 
{"TMDB": "4977",
"IMDb": "tt0851578"
},
"type": "VOD"
},
{"id": "S12137510000",
"title": "Caprica",
"externalIds": 
{"TMDB": "877",
"IMDb": "tt0799862"
},
"type": "VOD"
},
{"id": "M709620000",
"title": "eXistenZ",
"externalIds": 
{"TMDB": "1946",
"IMDb": "tt0120907"
},
"type": "VOD"
},
{"id": "S17625250000",
"title": "Sword Art Online",
"externalIds": 
{"TMDB": "45782",
"IMDb": "tt2250192"
},
"type": "VOD"
}
],
"display": "spectacular & virtual reality",
"wishes": 
[
{"code": "16",
"display": "spectacular"
}
],
"themes": 
[
{"code": "521",
"display": "virtual reality"
}
],
"id": "16,521"
},
{"size": 6,
"contents": 
[
{"id": "M276590000",
"title": "Erik the Viking",
"externalIds": 
{"TMDB": "11828",
"IMDb": "tt0097289"
},
"type": "VOD"
},
{"id": "M1357670000",
"title": "Pirates of the Caribbean: The Curse of the Black Pearl",
"externalIds": 
{"TMDB": "22",
"IMDb": "tt0325980"
},
"type": "VOD"
},
{"id": "M8035730000",
"title": "Monster Hunt",
"externalIds": 
{"TMDB": "334298",
"IMDb": "tt3781476"
},
"type": "VOD"
},
{"id": "M5521410000",
"title": "Into the Woods",
"externalIds": 
{"TMDB": "224141",
"IMDb": "tt2180411"
},
"type": "VOD"
},
{"id": "M2082490000",
"title": "The Forbidden Kingdom",
"externalIds": 
{"TMDB": "1729",
"IMDb": "tt0865556"
},
"type": "VOD"
},
{"id": "M3752590000",
"title": "Mirror Mirror",
"externalIds": 
{"TMDB": "62764",
"IMDb": "tt1667353"
},
"type": "VOD"
}
],
"display": "adventure & laughs",
"wishes": 
[
{"code": "19",
"display": "laughs"
}
],
"themes": 
[
{"code": "13546",
"display": "adventure"
}
],
"id": "13546,19"
},
{"size": 10,
"contents": 
[
{"id": "M2080640000",
"title": "The Dark Knight",
"externalIds": 
{"TMDB": "155",
"IMDb": "tt0468569"
},
"type": "VOD"
},
{"id": "M206880000",
"title": "Aliens",
"externalIds": 
{"TMDB": "679",
"IMDb": "tt0090605"
},
"type": "VOD"
},
{"id": "M160240000",
"title": "The Terminator",
"externalIds": 
{"TMDB": "218",
"IMDb": "tt0088247"
},
"type": "VOD"
},
{"id": "M575020000",
"title": "Dark City",
"externalIds": 
{"TMDB": "2666",
"IMDb": "tt0118929"
},
"type": "VOD"
},
{"id": "M8209130000",
"title": "Suicide Squad 3D",
"externalIds": 
{"TMDB": "297761",
"IMDb": "tt1386697"
},
"type": "VOD"
},
{"id": "M838270000",
"title": "Pitch Black",
"externalIds": 
{"TMDB": "2787",
"IMDb": "tt0134847"
},
"type": "VOD"
},
{"id": "M3566020000",
"title": "The X-Files: Fight the Future",
"externalIds": 
{"TMDB": "846",
"IMDb": "tt0120902"
},
"type": "VOD"
},
{"id": "S17390480000",
"title": "Sleepy Hollow",
"externalIds": 
{"TMDB": "50825",
"IMDb": "tt2647544"
},
"type": "VOD"
},
{"id": "M1448940000",
"title": "Underworld",
"externalIds": 
{"TMDB": "277",
"IMDb": "tt0320691"
},
"type": "VOD"
},
{"id": "M1552530000",
"title": "Constantine",
"externalIds": 
{"TMDB": "561",
"IMDb": "tt0360486"
},
"type": "VOD"
}
],
"display": "dark atmosphere & special effects",
"wishes": [ ],
"themes": 
[
{"code": "151",
"display": "dark atmosphere"
},
{"code": "455",
"display": "special effects"
}
],
"id": "151,455"
},
{"size": 2,
"contents": 
[
{"id": "M2527820000",
"title": "Prince of Persia: The Sands of Time",
"externalIds": 
{"TMDB": "9543",
"IMDb": "tt0473075"
},
"type": "VOD"
},
{"id": "S13439310000",
"title": "Xena",
"externalIds": 
{"TMDB": "4616",
"IMDb": "tt0112230"
},
"type": "VOD"
}
],
"display": "fantasy & heroic fantasy",
"wishes": [ ],
"themes": 
[
{"code": "13544",
"display": "fantasy"
},
{"code": "245",
"display": "heroic fantasy"
}
],
"id": "13544,245"
},
{"size": 5,
"contents": 
[
{"id": "M745520000",
"title": "Fight Club",
"externalIds": 
{"TMDB": "550",
"IMDb": "tt0137523"
},
"type": "VOD"
},
{"id": "M376520000",
"title": "Demolition Man",
"externalIds": 
{"TMDB": "9739",
"IMDb": "tt0106697"
},
"type": "VOD"
},
{"id": "S2131100000",
"title": "Buffy the Vampire Slayer",
"externalIds": 
{"TMDB": "95",
"IMDb": "tt0118276"
},
"type": "VOD"
},
{"id": "S3173950000",
"title": "Angel",
"externalIds": 
{"TMDB": "2426",
"IMDb": "tt0162065"
},
"type": "VOD"
},
{"id": "M353890000",
"title": "Buffy the Vampire Slayer",
"externalIds": 
{"TMDB": "10206",
"IMDb": "tt0103893"
},
"type": "VOD"
}
],
"display": "1990's movies and TV shows & fistfights",
"wishes": [ ],
"themes": 
[
{"code": "6512",
"display": "1990's movies and TV shows"
},
{"code": "95",
"display": "fistfights"
}
],
"id": "6512,95"
}
]
}

TV HABITS

Personalized EPG with a immediate access to the user's favorites programs.

YOUR FAVOURITE TV SHOW

Display the user's favorite TV shows and TV events. TV habits identify the next occurrences of the TV shows that the user watches on a regular basis.

Authorizations:

APIKeyQueryParam

path Parameters

user

required

string

Provide the user Id. Example: John - The user id must be provided in UTF-8 standard

query Parameters

device	string Define the platform on which the interactions occurred. This can be helpful to identify discrepancies in usage between platforms like TV, tablet, web, mobile apps.
details	boolean You can choose to display your meta-data in order to save precious response time. By default this parameter is marked "false", details are not automatically shown. To show details, you have to ask for "true".
skip	integer You can use this parameter to skip the first results that would be displayed. For example: skip=5 means not showing the first 5 results. Default value=0
limit	integer Number of results requested (max.100). The default value=10
displaysize	boolean You can choose to display the total number of results by using "true". The default value= false
language	string Enum: "br" "de" "en" "fr" "id" "ms" "ph" "pt" "es" "th" Language in which the metadata is displayed: en - english (default) fr - french de - german br - brazilian portuguese es - spanish id - indonesian ms - malay ph - filipino *th - thai
catalogs	string Define your choice of catalog names, in case you have multiple catalogs, on which recommendations are applied, separated by a comma (,).
tabs	string If your platform's interface is divided into separate sections or tabs for specific content 'groups', you can filter the recommendation for each section with this 'tab' parameter. In order to use this parameter, you must provide information about these specific content sections on your platform to Spideo beforehand and separate each tab by a comma (,).
territories	string If your platform is available in multiple countries and/or territories, this parameter allows to filter the recommendation results based on these territories. In order to use this parameter you must provide Spideo with the territory rights for each piece of content, within the catalog import process, and indicate for each content item to which territory it belongs.
distributions	integer "If your platform is available with several distributions business models, this parameter allows to filter the recommendation results based on these distributions. In order to use this parameter you must provide Spideo with the distributions rights for each piece of content, within the catalog import process, and indicate for each content item to which distribution it belongs.Example:TVOD, SVOD, AVOD
offers	integer "This parameter allows you to filter recommendations results to only provide suggestions on programs available in the user's offers subscribtions. In order to use this parameter you must provide Spideo with the offers rights for each channel, catchup store or VOD catalog.
platform	integer This parameter allows you to filter the recommendations results on the platforms on which the content are available. In order to use this parameter you must provide Spideo with the platform rights for each piece of content, within the catalog import process, and indicate for each content item to which pltaform it belongs. Example of values that can be configured:stb, ios, android.
infrastructure	integer "This parameter allows you to filter the recommendations results on the infrastructures on which the content are available. In order to use this parameter you must provide Spideo with the infrastructure rights for each piece of content, within the catalog import process, and indicate for each content item to which infrastructure it belongs. Example of values that can be configured: FTTH, FTTB, ADSL.
operator	integer "This parameter allows you to filter the recommendations results on the operators on which the content are available. In order to use this parameter you must provide Spideo with the operator rights for each channel, catchup store or VOD catalog.
lineups	string This parameter allows you to filter the recommendations results on a group of TV channels defined under a lineup id.
channel	string When the Business Rules Network Restrictions is activated recommendations can be filtered on group of channels. This parameter needs to be added to the recommendation calls to identify for each channel on which group it belongs. When a channel id is entered with this parameter, recommendations will only be provided on the channels linked to the same media group. List of channels by id, separated by a comma (,)Screen reader support enabled.
channels	string This parameter allows you to filter the recommendations results to only provide results on the channels listed in this parameter. List of channels by id, separated by a comma (,)
recency	integer If you want to restrict recommendation only to recent content you can use this parameter. As a value pass the number of months a content item can be recommended after having been added to the catalog. It can for example be based on publication dates. For instance: recency=5 means not showing content that has a publication date >5 months. The default value=0"
sections	string If you want to restrict the recommendations to a specific section, you can pass the section code as a value to this parameter.

Responses

Response samples

Content type

application/json


{"size": "4",
"contents": 
[
{"id": "EP006819110232",
"title": "NCIS",
"type": "TV",
"nextBroadcast": 
{"channelId": "TV_74030",
"broadcastTime": "2021-05-18T17:30Z"
}
},
{"id": "EP019223100029",
"title": "NCIS: New Orleans",
"type": "TV",
"nextBroadcast": 
{"channelId": "TV_18510",
"broadcastTime": "2021-05-19T11:00Z"
}
},
{"id": "EP000176170266",
"title": "Law & Order",
"type": "TV",
"nextBroadcast": 
{"channelId": "TV_16108",
"broadcastTime": "2021-05-20T17:00Z"
}
},
{"id": "EP007542010178",
"title": "Bones",
"type": "TV",
"nextBroadcast": 
{"channelId": "TV_18510",
"broadcastTime": "2021-05-20T22:00Z"
}
}
]
}

STEP BY STEP

Step by step recommendation experience.

NEXT IN LINE RECOMMENDATIONS

The step-by-step feature exists in order to facilitate the implementation of lean back, immersive and personalized streaming experiences. This endpoint will return recommended items one after the other instead of showing a long list of content IDs.

Authorizations:

APIKeyQueryParam

path Parameters

user

required

string

Provide the user Id. Example: John - The user id must be provided in UTF-8 standard

query Parameters

details	boolean You can choose to display your meta-data in order to save precious response time. By default this parameter is marked "false", details are not automatically shown. To show details, you have to ask for "true".
language	string Enum: "br" "de" "en" "fr" "id" "ms" "ph" "pt" "es" "th" Language in which the metadata is displayed: en - english (default) fr - french de - german br - brazilian portuguese es - spanish id - indonesian ms - malay ph - filipino *th - thai

Responses

Response samples

Content type

application/json


{"content": "M9352300000",
"wishes": 
[
{"code": "16",
"display": "spectacular"
},
{"code": "2",
"display": "beautiful"
},
{"code": "3",
"display": "twisty"
}
],
"themes": 
[
{"code": "204",
"display": "female action heroes"
},
{"code": "411",
"display": "robots"
},
{"code": "13548",
"display": "action"
},
{"code": "13542",
"display": "science fiction"
},
{"code": "13544",
"display": "fantasy"
},
{"code": "231",
"display": "genetically modified humans"
},
{"code": "283",
"display": "investigations"
},
{"code": "514",
"display": "urban landscapes"
},
{"code": "247",
"display": "high-tech"
},
{"code": "137",
"display": "conspiracies"
},
{"code": "1076",
"display": "Japan"
},
{"code": "225",
"display": "dystopia"
},
{"code": "422",
"display": "scientists"
},
{"code": "521",
"display": "virtual reality"
},
{"code": "515",
"display": "American fictions"
}
],
"genres": [ ],
"guarantee": 
{"content": 
{"id": "M722830000",
"title": "The Matrix",
"externalIds": 
{"TMDB": "603",
"IMDb": "tt0133093"
},
"type": "VOD"
},
"display": "spectacular & virtual reality",
"language": "en",
"wishes": 
[
{"code": "16",
"display": "spectacular"
}
],
"themes": 
[
{"code": "521",
"display": "virtual reality"
}
]
},
"language": "en"
}

GUARANTEES

Guarantee the relevancy of a recommendation.

Find out more on spideo.tv

RECOMMENDATIONS EXPLAINED

The purpose of the Guarantee feature is to explain users why they are being recommended content. The explanation comes in two ways. Every recommended content is (i) compared to another title that previously generated a meaningful interaction, (ii) linked to keywords the both pieces of content, the one previously watched and the one recommended, have in common.

Authorizations:

APIKeyQueryParam

path Parameters

contentId

required

string

Provide the internal ID or 3rd party metadata provider ID. Example: 603

query Parameters

details	boolean You can choose to display your meta-data in order to save precious response time. By default this parameter is marked "false", details are not automatically shown. To show details, you have to ask for "true".
language	string Enum: "br" "de" "en" "fr" "id" "ms" "ph" "pt" "es" "th" Language in which the metadata is displayed: en - english (default) fr - french de - german br - brazilian portuguese es - spanish id - indonesian ms - malay ph - filipino *th - thai

Responses

Response samples

Content type

application/json


{"content": "M722830000",
"guarantee": 
{"content": 
{"id": "M722830000",
"title": "The Matrix",
"externalIds": 
{"TMDB": "603",
"IMDb": "tt0133093"
},
"type": "VOD"
},
"display": "spectacular & virtual reality",
"language": "en",
"wishes": 
[
{"code": "16",
"display": "spectacular"
}
],
"themes": 
[
{"code": "521",
"display": "virtual reality"
}
]
},
"language": "en"
}