This request offers insight into some of the custom capabilities available from Rovi Advanced Search. This is one of several Advanced Search requests that show how Rovi can return entertainment content customers are looking for.
Advanced Faceted Search can return content based on the following filters specified in the request:
endpoint/filterbrowse?apikey=apikey&sig=sig&entitytype=entitytype [&filter=filter] [&boost=boost] [&available‑clu=available‑clu] [&available‑start=available‑start] [&available‑end=available‑end] [&include=include] [&facet=facet] [&format=format] [&country=country] [&language=language] [&offset=offset] [&size=size]
♫ Music-related requests 日 Movie-related requests ⊑⊒ TV-related requests
| Parameter | Required | Description | |||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| apikey | Yes | Access code that authorizes your request for data from Rovi. | |||||||||||||||||||||||||||||||||||||||||||
| endpoint | Yes | Database to search.
| |||||||||||||||||||||||||||||||||||||||||||
| entitytype | Yes | Type of content to search for.
| |||||||||||||||||||||||||||||||||||||||||||
| sig | Yes | A calculated, 32-hex-digit authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three ASCII strings:
Express the alpha hex digits as lower case. Perform the calculation at the time of each request to be sure it's within a five-minute window of the server time. If you're testing the call in a browser, use our online signature generator to perform the calculation. | |||||||||||||||||||||||||||||||||||||||||||
| available-clu | No | Service ID of a television service that has upcoming movies or TV series you want to match against. Service IDs for television services are available with calls to Services.
Broadcast times of programs are returned in availabilities objects. To return multiple broadcast times, specify the maximum number of broadcasts as serviceID,number like this: available‑clu=360861,5. Notes:
| |||||||||||||||||||||||||||||||||||||||||||
| available-end | No | If you specify the available‑clu parameter, available‑end specifies the end of the broadcast time window in one of the following formats:
If not specified, the end time is two weeks after the time of the request. | |||||||||||||||||||||||||||||||||||||||||||
| available‑start | No | If you specify the available‑clu parameter, available‑start specifies the start of the broadcast time window in one of the following formats:
If not specified, the start time is the time of the request. | |||||||||||||||||||||||||||||||||||||||||||
| boost | No | Sort-order priorities you can increase or decrease by a decimal value between -1 and 1. To boost the priority of new content by 50%, for example, specify boost=new:0.5. The priorities you can increase and decrease are:
To boost multiple factors, specify multiple parameters: boost=new:0.5&boost=alltime:‑0.4. Note: The sum of the absolute values of all factors must be less than or equal to 1. That is, add all of the absolute values together and make sure the total is less than or equal to 1. If you are using the clu parameter, you also can use the boost parameter to filter out results that are not available on the television service. Specified without a value, like this: boost=availability. | |||||||||||||||||||||||||||||||||||||||||||
| country | No | Country the language parameter applies to. The current release of the API supports only US. | |||||||||||||||||||||||||||||||||||||||||||
| facet | No | Count of items available to be returned.
| |||||||||||||||||||||||||||||||||||||||||||
| filter | No | Field content that determines which results are returned. Like a WHERE clause in an SQL statement, this parameter selects only results with fields that meet your criteria.
Examples:
The selection operators include:
For the And operation, specify another filter parameter like this: filter=releasedate>:20070101&filter=releasedate<20080101. A request can contain up to 20 filter parameters. The following shows which fields you can select for each entity type. If you specify a filter that does not apply to an entity type, no data will be returned for that entity type.
* Note: The availability filter is specified without a value, like this: filter=availability. Use this to filter out results that are not found in available‑clu. Additional Rovi Advanced Search Filter Rovi Advanced Search also provides the following filter for an endpoint of video and an entitytype of movie or tvseries:
| |||||||||||||||||||||||||||||||||||||||||||
| format | No | Format of the returned data: json or xml. The default is XML.
Alternatively you can specify the response format in an HTTP Accept header with either of these Accept field content types:
If you specify both, the format parameter overrides the Accept header. | |||||||||||||||||||||||||||||||||||||||||||
| include | No | Additional data to include in each result returned. To include cast members in movie results, for example, specify include=cast. For multiple includes, separate the values with commas like this: include=moods,crew. To include all data, specify include=all.
| |||||||||||||||||||||||||||||||||||||||||||
| language | No | Language of the response data. This request supports only en (English). | |||||||||||||||||||||||||||||||||||||||||||
| offset | No | Counting from zero as the first item in the returned list, the number of the first item you want. The default is zero. The maximum is 3000.
Use the offset and size parameters to paginate the available results. | |||||||||||||||||||||||||||||||||||||||||||
| size | No | The number of items you want to be returned. The default is 20. | |||||||||||||||||||||||||||||||||||||||||||
| Response | Type | Description |
|---|---|---|
| controlSet | ControlSet | The HTTP response status. |
| id | string | Server transaction ID for the response. |
| Response | Type | Description |
|---|---|---|
| facetCounts | facetCounts [ ] | Number of results available to be returned in each genre or entity type, as requested by the facet parameter. |
| results | result [ ] | The search results listed in order of popularity and similarity and the filters specified in the request. |
| totalResultCounts | integer | Total number of results found. |
| Code | Description |
|---|---|
| 400 | Incorrect or invalid request. The reason is shown in the Message object in ControlSet. |