Common

List of Countries.

get

List of Countries, ISO codes and Country IDs used throughout the API.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/Countries/

List of Languages.

get

Returns a list of languages used in the API as well as the ISO code and language ID.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/Languages/

Gets all EncodeTypes.

get

Videos are encoded in various formats and bitrates to reach any screen and work with any player.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/EncodeTypes/

List of Image Types.

get

A list of image types available in the IVA database. EX: Poster

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/ImageTypes/

List of Tags (with paging

get

Paged list of all tags used in the API.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
Skipinteger · int32Required

Offset for paging. Default is 0.

Takeinteger · int32Required

Maximum number of rows returned. Default is 1,000.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/Tags/

List of Video Types.

get

Returns a list of the types of videos that can be associated to a title.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/VideoTypes/

List of Common Enumerators.

get

Provider enumerator has values added regularly. Update your SDK to refresh these values.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/GetCommonEnumerators

List of Originating Networks.

get

No parameters.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/OriginatingNetworks/

List of Trend Sources.

get

List of Trend Sources.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/TrendSources

List of filter options available in data demo.

get

List of filter options available in data demo.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/DataDemoFilters

List of Movie Certifications

get

Returns all Movie Certifications used in a movie response with the Releases object.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/MovieCertifications

List of Movie Genres

get

List of all movie genres used in the API.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/MovieGenres

List of Show Certifications

get

List of Show Certifications and definitions.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/ShowCertifications

List of Show Genres

get

Returns a list of all the show genres used in the IVA database.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/ShowGenres
get

Search collection data.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
Skipinteger · int32Optional

Rows to skip, used for paging. Default is 0.

Takeinteger · int32Optional

Rows to return, used for paging. Default is 10, limit is 50.

Idsstring[]Optional

List of collection Ids.

ParentCollectionIdsstring[]Optional

List of Parent Collection Ids.

AnyIdsstring[]Optional

ID or ParentIDs matches.

ProgramIdsstring[]Optional

Filter collections containing these ProgramIds. Ex: Movie/123

NameSearchstringOptional

Search for collections by name, description.

Typesstring[]Optional

Filter collections by collection types.

SearchAllTermsstring[]Optional

Search collections across all data points for recommendations.

NextPageTokenstringOptional

Used for deep paging of record (beyond 10,000). Provide the NextPageToken returned from search results when using Timestamp sorting for optimal performance while paging large result sets. Skip is ignored when this parameter is provided.

SortBystringOptional

Sort order of results.

ModifiedRecordsSincestring · date-timeOptional

Filter results based on timestamp. Returns >= value timestamp (UTC) provided.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

get
/Common/Collections/Search/

Search collections.

post

Search collection data.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Body
SkipintegerOptional

Rows to skip, used for paging. Default is 0.

TakeintegerOptional

Rows to return, used for paging. Default is 10, limit is 50.

IdsarrayOptional

List of collection Ids.

ParentCollectionIdsarrayOptional

List of Parent Collection Ids.

AnyIdsarrayOptional

ID or ParentIDs matches.

ProgramIdsarrayOptional

Filter collections containing these ProgramIds. Ex: Movie/123

NameSearchstringOptional

Search for collections by name, description.

TypesarrayOptional

Filter collections by collection types.

SearchAllTermsarrayOptional

Search collections across all data points for recommendations.

NextPageTokenstringOptional

Used for deep paging of record (beyond 10,000). Provide the NextPageToken returned from search results when using Timestamp sorting for optimal performance while paging large result sets. Skip is ignored when this parameter is provided.

SortBystringOptional

Sort order of results.

ModifiedRecordsSincestringOptional

Filter results based on timestamp. Returns >= value timestamp (UTC) provided.

Responses
chevron-right
200

OK.

post
/Common/Collections/Search/

Last updated