Toplists for albums and movies are identical
The Popyoular API features a flexible toplist builder. You can request toplists for a set of sources as defined in a collection (common or partner specific), or individually for a review source.
For example:
http://apiv2.popyoular.se/music/review-sources/collections/shared/norwegian/toplistSelected-quoteis picked from several quotes for a single album, and is meant to be a simple way to quickly display a relevant quote. The review data for the selected quote is effectively duplicated later in the output, but is made available here for the sake of simplicity.
formatted-scoreis just a rounded, more presentation friendly version of the calculated popscore
| Parameter | Description | Values |
|---|---|---|
| time | Sets timeframe for reviewed items in toplist. | days (last 5 days), weeks [default] (last 7 days), month (last 30 days), last-month (last calendar month), months (last 3 months), year (last 365 days), last-year (last calendar year), years (last 3 years), all-time |
| max-length | Sets the maximum number of reviewed items to include in the toplist. | 10 |
| mapped-by | Only include items that have been mapped. This will create a toplist which only contains items available in your catalog | [your partner name] |
| tags | Only include items that have been mapped with the specified tags. | comma separated list of tags |
| locale | Specifies the locale to use when formatting dates and other locale sensitive strings returned by the API. | Default value: en_EN, Supported locales: en_EN, en_US, sv_SE, no_NO, de_DE, pt_PT, da_DA |
| min-score-quote | The API randomly selects quotes that end up in the 'selected-quotes'-tag. This parameter can be used to prevent selection of quotes from reviews with a normalized score (1-10) below a certain threshold. Makes it easy to display only positive quotes without the need for client side logic. | Default value: 0 (All quotes eligible for random selection) |
| min-score-review-quote | This parameter is similar to the above but affects the content of the 'quotes'-tag of each individual review. Excludes the quotes if the individual review has a normalized score below the given threshold. | Default value: 0 (Include quotes regardless of normalized score) |
| include-reviews | Controls the maximum the number of reviews to include in the 'reviews'-tag | Default value: 5 |
| backfill | Adds reviews from other collections if there are not enough reviews in the chosen collection to meet the number specified by the 'include-reviews'-parameter described above. | [collections, comma separated], For example: 'shared/swedish,shared/english' (be sure to URL-encode the slashes) |
| min-score-review | Excludes reviews with a normalized score below the given threshold. | Default value: 0 (Include all reviews) |
| min-count | If the number of reviews of an item is low, the aggregated score is not a very good indicator of the overall critical reception. This parameter controls the minimum number of reviews required for the aggregated review to be considered valid. If the number of reviews in the collection is lower than the given threshold the API will return a 404 response | Default value: 6 |
| include-cover-art | Controls whether album covers are included in the result | Default value: false |