Download OpenAPI specification:Download
Spideo's API offers a collection of endpoints that will allow you to integrate our services into your applications. The APIs are ready to deliver recommendations for Live TV, VoD, and Catch-up along with time-based features.
Configure the ideal configuration for your recommendation engine.
Set up of time-based configuration for profile based recommendation features. The time based setting can influence the reco algorithm by identifying a consumption pattern based on the interactions performed the previous week at each moment of each day.
| useTimeBasedRecommendation required | boolean Enum: true false Default value; true Allowed value; true or false |
Allow the ability to activate the display of a list of the most watched titles as a fallback when a user has no history or if there is not enough personalized recommended content to display.
| fallbackPopular required | boolean Enum: true false Default value; true Allowed value; true or false |
Define the minimum number of content each thematic category must contain to be selected for recommendation. We call “categories”, the Semantic personalized recommendations displayed in thematic playlists. Each playlist combines two of the user’s favorite themes.
| minimumElementsByPlaylistForCategories required | integer Default value : 5 |
Define how positive, neutral and negative ratings can be performed. Set up the scale of the rating by defining the minimum value allowed for a user’s rating. The default value is -1.
| ratingMin required | integer "Only integers values are allowed. Example: If ratingMin= -1 and" "ratingMax=1, the user will have 3 rating stages : -1; 0; 1" |
Define how positive, neutral and negative ratings can be performed. Set up the scale of the rating by defining the maximum value allowed for a user’s rating. The default value is 1.
| ratingMax required | integer "Only integers values are allowed. Example: If ratingMin= -1 and" "ratingMax=1, the user will have 3 rating stages : -1; 0; 1" |
Define the number of days of interactions to take into account in the calculation of personalized recommendations. By default, the number of days taken into account is the maximum available, 90 days.
| value required | integer Define the number of days of interactions to take into account in the calculation of personalized recommendations |
Watchings events (video in progression) can become Watches (video completed) when the video player get past a percentage viewed threshold. This business rules allows to modify this value to define which percentage should be reached to consider a video as watched. By default, 85 % is defined as the threshold of transformation from watchings to watches event.
| value required | integer Default value 85% |
Define if titles on which an interaction has been performed should be returned in recommandation.
| interactionType required | string Enum: "alert" "ban" "dislike" "like" "playlist" "record" "view" "watch" "watching" Select the interaction type |
| activated required | boolean Enum: true false Default value; true Allowed value; true or false |
Allow the ability to activate the display of a playlist of content as a fallback when the referenced title has been defined as not eligible to semantic recommendation.
| boolean required | boolean Enum: true false Default value; true Allowed value; true or false. |
Define the minimum number of content each thematic pair must contain to be eligible for recommendation. We call “pairs”, the Semantic content to content suggestions displayed in thematic playlists. Each playlist is created by the combination of two of the content main themes or one theme and one mood.
| minimumElementsByPlaylistForPairs required | integer Default value : 5 |
Define in Live universes if you want to recommend titles that have already begun. There are 3 allowed values to define which titles are eligible for recommendation in Live universes: 0: we don’t recommend content that is currently airing. 1: we recommend all content that is currently already airing. 0.5: we only recommend content that has recently started (less than half of the time has passed).
| value required | integer Enum: 1 0.5 0 "Default value : 1 Allowed values: 0 : we don’t recommend the" "content that is currently airing 1 : we recommend all the content" "that is currently airing" "0.5 : we only recommend content that has" "been partially watched (less than half)" |
Define the limit of the universe Now in minutes. The results of the recommendations in the Live universe Now will includes content that is airing at the moment and content that will air in the next X minutes.
| value required | integer "Default value : 15" |
Define if you want to recommend titles only between some channels or group of channels. TV channels can belong to specific groups or networks. Example: the Showtime network gathers several TV channels like Showtime, Showtime 2, Showtime Extreme, etc. If a TV content is broadcasted on a channel that belongs to a group, the algorithm can filter the results of the recommendation to display only content belonging to that group.
| networkRestrictions required | boolean Enum: true false Default value; true Allowed value; true or false |
Define if the content's saga should be displayed in the content's similar. There are 3 allowed values to define it. NEXT_EXCLUDE_REF: No contents saga will display in the response NEXT: Display only the next episode from saga ALL: Display all the episode from saga in the response
| similarSagaStrategy required | string Default value : NEXT |
Define if you want to recommend episodes or a series in its globality. Metadata, availability rights and a series ids unifying all episodes would need to be provided on each episode in order to activate this business rules.
| recommendEpisodes required | boolean Enum: false true "Default value : false" "Example:" "*recommendEpisodes=false =>" "Recommendation; # Breaking Bad" "*recommendEpisodes=true =>" "Recommendation; # Breaking Bad +Season 1 *Episode 1- Chute Libre" |
If series are recommended at episode level, define if, for a series never seen by a user, personalized recommendations should be done on the first episode of the first season or on the first episode of the latest season available.
| recommendedSeason required | string Enum: "FIRST_SEASON" "LAST_SEASON" Default value : FIRST_SEASON Allowed value : FIRST_SEASON, LAST_SEASON |
Define the minimum number of content each thematic playlist must contain to be eligible for Surprise . Each playlist is created by the combination of two themes and one mood and one theme available on the platform.
| minimumElementsByPlaylistForSurprise required | integer Default value : 5. |
Reorder the results provided by the recommendations features from the most recent to the oldest.
Take into account the publication date on your platform to reorder recommendations results from the most recent published title to the oldest.
| publicationDateRecency required | boolean Enum: true false Default value; true Allowed value; true or false |
Configuration of each interaction's impact on the calculation of the User Semantic Fingerprint
Define if an interaction type should be taken into account in the creation of the user's taste profile.
| interactionType required | string Enum: "alert" "ban" "dislike" "like" "playlist" "record" "view" "watch" "watching" Select the interaction type |
| activated required | boolean Enum: true false Default value; true Allowed value; true or false |
Define the coefficient of relevancy for each interaction type in the calculation of the user's taste profile.
| interactionType required | string Enum: "alert" "ban" "dislike" "like" "playlist" "record" "view" "watch" "watching" Select the interaction type |
| coefficient required | integer value (or weight) to be attributed to an interaction type in the calculation of a USF |
Create a list of content that should be boosted in the recommendations services results. When the content present in the list is eligible to recommendations it will appear in the first position.
| contentsIds required | string Provide the internal ID or 3rd party metadata provider ID. |
Remove content from the boostlist to let them be recommended with their initial value. The boostlist enables you to boost content and make it available before other recommendations.
| contentsIds | string Provide the internal ID or 3rd party metadata provider ID. |
Create a list of content that should be banned from suggestions provided by the recommendations services. Once a piece of content is defined to not be eligible to be recommended, it will disappear from the list of recommendations results.
| contentsIds required | string Provide the internal ID or 3rd party metadata provider ID. |
Remove titles from the banlist in order to make them available again for recommendations. Content in banlist is defined to not be eligible to be recommended.
| contentsIds | string Provide the internal ID or 3rd party metadata provider ID. |
Create a list of content that should be boosted in the recommendations services results. When the content present in the list is eligible to recommendations it will appear in the first position.
| contentsIds required | string Provide the internal ID or 3rd party metadata provider ID. |
Remove titles from the boostlist to let them be recommended with their initial value. The boostlist enables you to boost content and make it available before other recommendations.
| contentsIds | string Provide the internal ID or 3rd party metadata provider ID. |
Create a list of content that should be banned from suggestions provided by the recommendations services. Once a piece of content is defined to not be eligible to be recommended, it will disappear from the list of recommendations results.
| contentsIds required | string Provide the internal ID or 3rd party metadata provider ID. |
Remove titles from the banlist in order to make them available again for recommendations. Content in banlist is defined to not be eligible to be recommended.
| contentsIds | string Provide the internal ID or 3rd party metadata provider ID. |
Create a list of content that should be boosted in the recommendations services results. When the content present in the list is eligible to recommendations it will appear in the first position.
| contentsIds required | string Provide the internal ID or 3rd party metadata provider ID. |
Remove titles from the boostlist to let them be recommended with their initial value. The boostlist enables you to boost content and make it available before other recommendations.
| contentsIds | string Provide the internal ID or 3rd party metadata provider ID. |
Create a list of content that should be banned from suggestions provided by the recommendations services. Once a piece of content is defined to not be eligible to be recommended, it will disappear from the list of recommendations results.
| contentsIds required | string Provide the internal ID or 3rd party metadata provider ID. |
Remove specific titles from the banlist in order to make them available again for recommendations. Content in banlist is defined to not be eligible to be recommended.
| contentsIds | string Provide the internal ID or 3rd party metadata provider ID. |