Query String Parameters

These query string parameters can be used on API requests for similar/related assets, trending, and personalized recommendations.

Note: Rather than constructing ad hoc requests (with individual parameters for each request), consider using discovery profiles to centralize your settings and recommendations behavior. Discovery profiles are defined configurations of settings created by you, which you then reuse by reference on the GET routes. For more information, see Discovery Profiles.

Use the following query string parameters to modify the base set of results returned by the following requests:

Parameter Description Required?
discovery_profile_id Identifier of a previously defined discovery profile. (Equivalent to the player ID of the defined profile displayed in the Backlot UI for Discovery.) See Discovery Design Considerations.

Type: String

Default: None

Example: discovery_profile_id=e18ab1da1813483499554ea2z8e67fbd

 
exclude_labels Specifies up to ten labels to exclude from the results, separated by commas.

Type: String

Default: None

Example: exclude_labels=hiamZvMjqKnLMr7xnMF-qcTEanQlhCQ1,pmd2xzMjrCg4TpQd6cwz9HP4U-pcFSHH

No
exclude_videos Specifies up to ten embed codes (asset IDs or content IDs) to exclude from the results, separated by commas. If you need to exclude more than ten videos, consider using the Editorial APIs.

Type: String

Default: None

Example: exclude_videos=hiamZvMjqKnLMr7xnMF-qcTEanQlhCQ1,pmd2xzMjrCg4TpQd6cwz9HP4U-pcFSHH

No
filter_by Part of the editorial functions, restricts the results to the specified labels.
Note: Always overrides any profiles specified with discovery_profile_id parameter.

The comma (,) in the value indicates logical OR.

Type: String

Default: None

Examples:

  • filter_by=cat (labels contain "cat")
  • filter_by=cat,piano (labels contain "cat" or "piano")
  • filter_by=shared:language (content has the same "language" sub label, such as "/language/english")
  • filter_by=cat,shared:language (labels have "cat" label or the same language sub label)
No
limit The maximum number of results to return.
Note: See Discovery Design Considerations about possible misuse of this parameter.

Type: Integer

Default: 10

Valid Values: 1-100

Example: limit=20

No
union Part of the editorial functions, specifies the content to inject and its location in the results.

Type: String

Default: None

Examples:

  • union=next|next_item|0 (injects the asset specified in the next_item content metadata entry into position 0 of the results)
  • union=n|next_item|0 (shortcut for previous example)
  • union=next|next_item|0,union=next|next_highlight|2 (injects the asset specified in the next_item content metadata entry into position 0 of the results and the asset specified in the next_highlights content metadata entry into position 2)
  • union=collection|2012-09_extreme_paint|1 (injects promotional content from the 2012-09_extreme_paint collection into position 1)
  • union=c|2012-09_extreme_paint|1 (shortcut for previous example)
  • union=collection|live|1 (injects a live asset into position 1)
  • union=collection|label:BasketballPromo|0 (injects promotional content from the BasketballPromo label into position 0)
  • union=collection|label:BasketballPromo|0|2012-10-29|2012-10-31 (injects promotional content from the BasketballPromo label into position 0, from 10/29/2012 to 10/31/2012)
No
where To include or exclude assets based on the values of their metadata or labels.
Note: The where clause is syntactically identical to the Backlot API query where clause.
Note: Make sure non-ASCII letters and ' characters are escaped.

Type: String

Default: None

Example:

where=metadata.sport='soccer'
No
See also Discovery Editorial Query String Parameters

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