Once you have the base URL for a movie or an album (described in Release Lookup) all of the path segments and query parameters described below are identical for movies and albums.
The release can be specified using any of the four methods described in the Release Lookup section of this documentation. This applies to all album based API calls described below.
This will return a plain, non-aggregated review list. The list will be empty if there are no reviews of the release in the specified collection.
The XML-data should be fairly self-explanatory:
| Parameter | Description | Values |
|---|---|---|
| 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-review | Excludes any reviews with a normalized score below the given threshold. | Default value: 0 (Include all reviews) |
| min-score-review-quote | Exclude all quotes if the normalized score of the review is below the given threshold. Makes it easy to display only positive quotes without the need for client side logic. | Default value: 0 (Include quotes regardless of normalized score) |
| Parameter | Description | Values |
|---|---|---|
| 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 a quotes that endsup 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] |
| min-score-review | Excludes reviews with a normalized score below the given threshold. | Default value: 0 (Include all reviews) |
| min-collection-count | If the number of reviews of an item are 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: 4 |
| include-cover-art | Controls whether cover art is included in the result. Not yet supported by the Movie version of the API | Default value: false. |
The following example returns aggregated reviews from the swedish collection for the albums "Yankee Hotel Foxtrot" and "Heavy Metal Fruit":
http://apiv2.popyoular.se/music/review-sources/collections/shared/all/multiple?keys=wilco%2fyankee-hotel-foxtrot,motorpsycho%2fheavy-metal-fruitThis also works for custom collections:
http://apiv2.popyoular.se/music/review-sources/collections/[partner]/[collection]/multiple?keys=wilco%2fyankee-hotel-foxtrot,motorpsycho%2fheavy-metal-fruitMultiple reviews can also be retrieved using your internal identifiers, simply add your partnerId to the path:
http://apiv2.popyoular.se/music/review-sources/collections/shared/all/multiple/[partnerId]/?keys=1234,12345When requesting multiple aggregated reviews you can use the same parameters as when requesting a single aggregated review (i.e. all parameters from the table above)
By adding the parameter score-limit you can limit the review data that's returned to only those releases whose aggregated score is equal to or greater than a certain value. For example, at the time of writing, the example below will not return any data for the Motorpsycho album since that album has a popscore below the value required.
http://apiv2.popyoular.se/music/review-sources/collections/shared/all/multiple?keys=wilco%2fyankee-hotel-foxtrot,motorpsycho%2fheavy-metal-fruit&score-limit=9.5The returned review list is keyed by the release identifiers (either the popyoular identifiers or your internal identifiers, depending on which you used in the request). This makes it easy to match the returned reviews with the releases in the client
Sample XML response snippet (lots of output omitted for brevity)