Retrieves all alert interactions coming from the user's history.
| user required | string Provide the user Id. Example: user123 |
| 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". |
Perform an alert interaction on a title. This interaction can only be performed on Live content.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID. Example: 603 |
| origin | string This param allows identifying the source of the users interactions. Thanks to the "origin," the platform can flag how users are using recommendation rails to discover new content. For instance, the origin of a users interactions can be any Spideo recommendation feature or any clients editorial rails. |
| 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. |
| distributions | string 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 |
Deletion of an alert interaction on a given piece of content from the user's history.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID. Example: 603 |
Retrieves the interactions records coming from the user's history.
| user required | string Provide the user Id. |
| 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". |
Perform a recording interaction on a title. This interaction can only be performed on Live content.
| user required | string Provide the user Id. |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID. |
| origin | string This param allows identifying the source of the users interactions. Thanks to the "origin," the platform can flag how users are using recommendation rails to discover new content. For instance, the origin of a users interactions can be any Spideo recommendation feature or any clients editorial rails. |
| 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. |
| distributions | string 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 |
View events track every click on content when users want to check out a content page or read a content description.
This endpoint retrieves the interactions of a given type, in this case 'click', coming from the user's history. The interaction 'click' is defined by the user clicking on the recommended content.
| user required | string Provide the user Id. |
| 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". |
This endpoint saves the user interaction 'click' for a given piece of content. The interaction 'click' is defined by the user clicking on the recommended content.
| user required | string Provide the user Id. |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID. |
| origin | string This param allows identifying the source of the users interactions. Thanks to the "origin," the platform can flag how users are using recommendation rails to discover new content. For instance, the origin of a users interactions can be any Spideo recommendation feature or any clients editorial rails. |
| 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. |
| distributions | string 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 |
This endpoint deletes the user interaction 'click' for a given piece of content. The interaction 'click' is defined by the user clicking on the content.
| user required | string Provide the user Id. |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID. |
Retrieves the watches interactions in the user's history.
| user required | string Provide the user Id. Example: user123 |
| 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". |
Saves watch interactions on all pieces of content. Watch interactions are understood as watched entirely.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID.Example: 603 |
| 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. |
| origin | string This param allows identifying the source of the users interactions. Thanks to the "origin," the platform can flag how users are using recommendation rails to discover new content. For instance, the origin of a users interactions can be any Spideo recommendation feature or any clients editorial rails. |
| distributions | string 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 |
Deletion of a watch interaction on a given piece of content from the user's history.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID.Example: 603 |
| 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. |
A timecode parameter is mandatory for this interaction. It represents a percentage of the total lenght of the video player.
Retrieves the list of all videos that a user has started watching but has not completed.
| user required | string Provide the user Id. Example: user123 |
| 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". |
Saves the user's progress rate while watching a video. The percentage viewed must be passed using the timecode parameter, mandatory for this interaction. Beyond a defined threshold, the completion of a video transform the interaction from watchings, in progress to watch, watched entirely. The completion ratio value needed to consider a video as watched can be defined via the business rules watchingsToWatchesThreshold.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID.Example: 603 |
| timecode required | number <double> The progress rate in % of the user watching a piece of content. Allowed values are between: 0> timecode <100. By default the content is considered watched (from 'watching' to 'watch') by using a time code >86. |
| 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. |
| origin | string This param allows identifying the source of the users interactions. Thanks to the "origin," the platform can flag how users are using recommendation rails to discover new content. For instance, the origin of a users interactions can be any Spideo recommendation feature or any clients editorial rails. |
| distributions | string 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 |
Deletion of a watching interaction on a given piece of content from the user's history.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID.Example: 603 |
| 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. |
Listing of all content on which a rating interaction has been performed.
| user required | string Provide the user Id. Example: user123 |
| rating | string Enum: 0 1 -1 "This parameter allows you to specify a user’s rating. Allowed values: -1 is for disliked content, 0 when the user is indifferent and 1 for liked content." |
| skip | integer For similar content content recommendations, 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 |
| catalogs | string Define your choice of catalog names, in case you have multiple catalogs, on which recommendations are applied, separated by a comma (,). |
| 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". |
This endpoint saves a user’s rating for a given piece of content.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID.Example:603 |
| value required | string Enum: "." 0 1 -1 "This parameter allows you to specify a user’s rating. Allowed values -1 is for disliked content, 0 when the user is indifferent and 1 for liked content." |
| 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. |
| distributions | string 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 |
| origin | string This param allows identifying the source of the users interactions. Thanks to the "origin," the platform can flag how users are using recommendation rails to discover new content. For instance, the origin of a users interactions can be any Spideo recommendation feature or any clients editorial rails. |
Listing of all content on which a rating interaction has been performed.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID. Example: 603 |
| rating | string Enum: 0 1 -1 "This parameter allows you to specify a user’s rating. Allowed values: -1 is for disliked content, 0 when the user is indifferent and 1 for liked content." |
| skip | integer For similar content content recommendations, 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 |
| catalogs | string Define your choice of catalog names, in case you have multiple catalogs, on which recommendations are applied, separated by a comma (,). |
| 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". |
Listing of all content on which a playlist interaction has been performed.
| user required | string Provide the user Id. Example: user123 |
| 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". |
Saves the user interaction playlist for a given piece of content. Ability for the user to add content to a personal playlist or to their favorites.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID. Example;603 |
| origin | string This param allows identifying the source of the users interactions. Thanks to the "origin," the platform can flag how users are using recommendation rails to discover new content. For instance, the origin of a users interactions can be any Spideo recommendation feature or any clients editorial rails. |
| 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. |
| distributions | string 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 |
Deletion of a playlist interaction on a given piece of content from the user's history.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID. Example:603 |
Listing of all content on which a ban interaction has been performed.
| user required | string Provide the user Id. Example: user123 |
| 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". |
Bans a piece of content from all profile based recommendations.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID.Example:603 |
| origin | string This param allows identifying the source of the users interactions. Thanks to the "origin," the platform can flag how users are using recommendation rails to discover new content. For instance, the origin of a users interactions can be any Spideo recommendation feature or any clients editorial rails. |
| 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. |
| distributions | string 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 |
Retrieves all buys interactions coming from the user's history.
| user required | string Provide the user Id. Example: user123 |
| 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". |
Perform a purchasing interaction on a given piece of content.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID.Example: 603 |
| origin | string This param allows identifying the source of the users interactions. Thanks to the "origin," the platform can flag how users are using recommendation rails to discover new content. For instance, the origin of a users interactions can be any Spideo recommendation feature or any clients editorial rails. |
| 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. |
| distributions | string 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. |
Deletion of a buy interaction on a given piece of content from the user's history.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID.Example: 603 |
| 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. |
Retrieves all rent interactions coming from the user's history..
| user required | string Provide the user Id. Example: user123 |
| 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". |
Perform a rental interaction on a given piece of content.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID.Example: 603 |
| origin | string This param allows identifying the source of the users interactions. Thanks to the "origin," the platform can flag how users are using recommendation rails to discover new content. For instance, the origin of a users interactions can be any Spideo recommendation feature or any clients editorial rails. |
| 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. |
| distributions | string 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 |
Deletion of a rent interaction on a given piece of content from the user's history.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID.Example: 603 |
| 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. |
Retrieves all trailer interactions coming from the user's history.
| user required | string Provide the user Id. Example: user123 |
| 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". |
Identification of the watch interaction performed on a given piece of content's trailer.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID.Example: 603 |
| origin | string This param allows identifying the source of the users interactions. Thanks to the "origin," the platform can flag how users are using recommendation rails to discover new content. For instance, the origin of a users interactions can be any Spideo recommendation feature or any clients editorial rails. |
| 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. |
| distributions | string 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. |
Deletion of a trailer interaction on a given piece of content from the user's history.
| user required | string Provide the user Id. Example: user123 |
| contentId required | string Provide the internal ID or 3rd party metadata provider ID.Example: 603 |
| 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. |