# Collections Guide

## General Information

Collections is another data point that enriches the Entertainment API by connecting titles that are part of a film series or media franchise. Using Collection Types, Origin Nexus has created another way to organize lists of content under umbrellas such as Shared Universe, Iconic Characters, Iconic Authors, etc. Origin Nexus clients can then show other titles related to the one their users are viewing, helping to power stronger recommendations and drive more engagement.

Review the definitions and examples below to see how to work with the Collections data within the Entertainment API. If you have any questions please reach out to our support team.

*Related API Guides:* [*Entertainment API*](/origin/apis-all/entertainment-api-docs.md)

*Open API/Swagger documentation can be found on the Entertainment API page.*

## Collection Search Parameters

\
A new [Collection Search](/origin/apis-all/common-metadata-api-docs.md#collection-search-parameters) endpoint contained in the Common Metadata API has been introduced in order to search and ingest Collections.

### Entertainment Search Parameters

The Entertainment Search endpoint has introduced a couple of parameters offering options to explore the Collections metadata. Those parameters are detailed below:

* **CollectionIds** - A comma-separated list of CollectionIds that allows you to filter the Entertainment Programs returned to those programs contained in the specified Collections (either directly or through the Parent Collection). See below for details on Collections.
* **CollectionTypes** - A comma-separated list of CollectionTypes that allows you to filter the Entertainment Programs returned to those programs contained in Collections of the specified CollectionTypes. The current available values for CollectionTypes are: SequentialWork, IconicCharacter, SharedUniverse, IconicAuthor, IconicTitle, IconicPerformer, IconicStudio, IconicBrand.

### Entertainment Search Response - Collections

\
Making use of the "Includes" parameter of the Entertainment Search endpoint by setting "Includes=Collections" will return the Collections array on each program that is a member of at least one Collection. An example of a Collections array in an API response is below:

`"Collections":`
\
`[`
\
`{`
\
`"Id": "Collection/3",`
\
`"Name": "Superman",`
\
`"Description": "Based on the DC Comics character created by Jerry Siegel and Joe Shuster about an alien with super powers that defends earth",`
\
`"Types": [ "IconicCharacter" ],`
\
`"Timestamp": "2020-09-09T20:48:01.0000000Z"`
\
`},`
\
`{`
\
`"Id": "Collection/136",`
\
`"Name": "DC Animated Movie Universe",`
\
`"Description": "Based on characters created for DC Comics published by Warner Bros. Animation",`
\
`"Types": [ "SharedUniverse" ],`
\
`"Timestamp": "2020-09-09T20:53:17.0000000Z"`
\
`}`
\
`]` <br>

There are several metadata fields that make up a Collection object in the Entertainment Search response. They are described below:

* **Id** - String representing the CollectionId of the Collection.
* **Name** - String representing the Name of the Collection.
* **Description** - String containing a short description of the Collection.
* **Timestamp** - Datetime representing the last update on the Collection.

### Collection Types Descriptions

The following are brief descriptions of the Collection Types found in our Collections metadata.

* **SharedUniverse** - This is multiple movies that are all taking place in the same universe. Examples include Marvel Cinematic Universe, Wizarding World, etc.
* **IconicCharacter** - This is when a character is found in multiple movies and is one readily recognized by the general population. Examples include Superman, Dracula, Freddy Krueger, James Bond, Sherlock Holmes, etc.
* **IconicTitle** - This is used when the title is what is most recognized and is used in number of films or TV shows. Examples include Mission: Impossible, Jaws, Toy Story, The Matrix, Hamlet, etc.
* **IconicAuthor** - This is used when the author’s works have a number of movies and/or TV shows made from their works. Examples include Stephen King, Shakespeare, Agatha Christie, Jules Verne, etc.
* **IconicStudio** - This is used when the studio releasing it has a particular expectation of what their content will be like. Examples include Disney Animated Features, Dreamworks Animated Films, Hammer Studios, etc.
* **IconicPerformer** - This is used when a performer(s) are known for a particular type of performance when appearing in a title. Examples of comedy duos such as Laurel Hardy, Abbot and Costello, Marx Brothers, or Astaire and Rogers.
* **IconicBrand** - Brands are sometimes known to offer movie and TV shows such as LEGO or National Lampoon.
* **SequentialWork** - Any titles that have a specific sequence number in its title or is part of a well known franchise would be considered a sequential work. This should be an additional type that is added to one of the above when applicable.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://knowledgebase.fabricdata.com/origin/apis-all/entertainment-api-docs/collections-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.