The event methods allow you to easily build discovery features from this event data.
For example, you may want to build a simple stream of new reviews from a specific collection. Or you may want to build a stream of positive review quotes by getting a stream of quotes and setting a minimum score requirement.
You'll recognize these parameters from other methods.
| Parameter | Description | Values |
|---|---|---|
| type | The type of events to return. If no type is specified all event types will be included | quote, review |
| max-length | Sets the number of items to include in the event list. | 10 |
| next-token | The response contains an element called 'next-token'. Use this in a subsequent call the get the next page of events (going backwards in time) | |
| mapped-by | Only include items that have been mapped. This will create an event list only containing items available in your catalog | [your partner name] |
| max-publish-dff | Provides a mean to exclude reviews & quotes that were published a long time before they were added to the Popyoular database. | Default value: 30 (days) |
| 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 a quote that ends up in the 'selected-quote'-tag. This parameter can be used to prevent the 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-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 currently supported by the movie API | Default value: false |