Top Titles Route Parameters

Learn about the Top Titles route parameters and return values.

The following table describes the parameters use with the Top Titles route.
Table 1. Top Titles Parameters
Parameter Required? Type Description/Example
score_type Yes String This parameter is always assigned one value: top_titles. Usage is shown in the following example:
score_type=top_titles
show_type No String This parameter takes one of the following values:
  • Movie
  • Series
When this parameter is not invoked the results returned include movies and television shows.
show_type=Movie 
window No String This parameter defines the length of time within which the results are provided. It takes one of the following values:
  • hours — Results are provided for popular content within the hour.
  • day — Results are provided for popular content within a 24 hour period.
  • week — Results are provided for popular content within the last 7 days.
  • month — Results are provided for popular content within the last 30 days.
Usage is shown in the following example:
window=day
limit No String This parameter defines the maximum number of results to return. The default is 100 and valid values are from 1 to 500. Usage is shown in the following example:
&limit=7
The following table describes the route return value parameters.
Value Description/Example
id The unique identifier for the asset title. The syntax is shown in the following example:
"id": "ZpZXI5bjocHxChXG-8LKW8-5mYuxk4wm"
localized_names The asset language and associated name. The syntax is shown in the following example:
"localized_names": [
        {
          "name": "Name",
          "language": "es"
        }
      ]
score The asset popularity score. The value of a score is relative to any given query. The value does not indicate an absolute value for the returned asset.
Note: This function may change in the future, and substantial changes in the score of a particular asset do not necessarily mean substantial changes in the popularity of an asset.
"score": 642.0
show_type The asset type (Series or Movie). The syntax is shown in the following example:
"show_type": "Series" 

해당 내용이 도움 되었습니까?