For the complete documentation index, see llms.txt. This page is also available as Markdown.

Common

Gets DbCollectionItems by CollectionId.

get

Gets DbCollectionItems by CollectionId.

Path parameters
CollectionIdinteger · int32Required
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
DbCollectionItemResponse[]Optional
get/Common/Collections/{CollectionId}/Items/
200

Success

Gets all Child Collections of a given Collection.

get

Gets all Child Collections of a given Collection.

Query parameters
CollectionIdinteger · int32Optional
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
DbCollectionResponse[]Optional
get/Common/Collections/Children
200

Success

Gets all Collections containing a specific program.

get

Gets all Collections containing a specific program.

Query parameters
ProgramIdstringOptional
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
DbCollectionResponse[]Optional
get/Common/Collections/Program
200

Success

get

Search collection data.

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
200

Success

application/json

SearchCollectionResponse

Tookinteger · int64Optional
Totalinteger · int64Optional
MaxScorenumber · doubleOptional
MessagestringOptional
NextPageTokenstringOptional
get/Common/Collections/Search/
200

Success

Search collections.

post

Search collection data.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Body
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.

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.

ModifiedRecordsSincestring · date-timeOptional

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

Responses
200

Success

application/json

SearchCollectionResponse

Tookinteger · int64Optional
Totalinteger · int64Optional
MaxScorenumber · doubleOptional
MessagestringOptional
NextPageTokenstringOptional
post/Common/Collections/Search/
200

Success

Gets Collection suggestions for a specific program.

get

Gets Collection suggestions for a specific program.

Query parameters
ProgramIdstringOptional
Takeinteger · int32Optional
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json

SearchCollectionResponse

Tookinteger · int64Optional
Totalinteger · int64Optional
MaxScorenumber · doubleOptional
MessagestringOptional
NextPageTokenstringOptional
get/Common/Collections/Suggestions
200

Success

Returns Collection Types.

get

Returns Collection Types.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
string[]Optional
get/Common/CollectionTypes
200

Success

List of Countries.

get

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

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json

CountryResponse

Idinteger · int32Optional
FabricIdstringOptional

Fabric Language Id.

IsoCodestringOptional

ISO code for a Country.

IsoCodeA3stringOptional

ISO 3 character code for a Country.

NamestringOptional

Name of the Country.

AlternateNamesstring[]Optional

Alternate names of the Country.

get/Common/Countries/
200

Success

Get Country by ID.

get

Requires a valid Country ID.

Path parameters
Idinteger · int64Required
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json

CountryResponse

Idinteger · int32Optional
FabricIdstringOptional

Fabric Language Id.

IsoCodestringOptional

ISO code for a Country.

IsoCodeA3stringOptional

ISO 3 character code for a Country.

NamestringOptional

Name of the Country.

AlternateNamesstring[]Optional

Alternate names of the Country.

get/Common/Countries/{Id}
200

Success

List of filter options available in data demo.

get

List of filter options available in data demo.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json

DataDemoFilters

YearRangeinteger · int32[]Optional
AwardYearsinteger · int32[]Optional
RemoteIpstringOptional
get/Common/DataDemoFilters
200

Success

Gets all EncodeTypes.

get

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

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
EncodeTypeResponse[]Optional
get/Common/EncodeTypes/
200

Success

List of Common Enumerators.

get

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

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json

CommonEnumerators

Providerstring[]Optional
DeliveryMethodstring[]Optional
OfferTypestring[]Optional
VideoQualitystring[]Optional
CurrencyTypestring[]Optional
get/Common/GetCommonEnumerators
200

Success

List of CurrencyTypes.

get

List of CurrencyTypes.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
string[]Optional
get/Common/GetCurrencyTypes
200

Success

List of DeliveryMethods.

get

List of DeliveryMethods.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
string[]Optional
get/Common/GetDeliveryMethods
200

Success

List of OfferTypes.

get

List of OfferTypes.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
string[]Optional
get/Common/GetOfferTypes
200

Success

List of Providers.

get

List of Providers.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
string[]Optional
get/Common/GetProviders
200

Success

List of VideoQualities.

get

Returns Providers.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
string[]Optional
get/Common/GetVideoQualities
200

Success

Returns full history of the Images Changes, or partial history when FromDate is included.

get

Requires a valid ImageId, with optional FromDate.

Query parameters
Idinteger · int64Required

Required ID of Image.

FromDatestring · date-timeOptional

Optional FromDate to return partial history of Image changes. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
DbImageChangeResponse[]Optional
get/Common/Images/{Id}/Changes
200

Success

Returns Tags for an Image.

get

Requires a valid Image Id.

Query parameters
Idinteger · int64Required

Required ID of Image.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
DbImageTagResponse[]Optional
get/Common/Images/{Id}/Tags
200

Success

List of Image Types.

get

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

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
ImageTypeResponse[]Optional
get/Common/ImageTypes/
200

Success

List of Languages.

get

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

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json

LanguageResponse

Idinteger · int32Optional

Unique ID of a Language.

IsoCodestringOptional

ISO code for this Language.

NamestringOptional

Name of the Language.

FabricIdstringOptional

Fabric Language Id.

IETFCodestringOptional

IETF BCP 47 code for this language.

get/Common/Languages/
200

Success

Get Language by ID.

get

Requires a valid Language ID.

Path parameters
Idinteger · int64Required
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json

LanguageResponse

Idinteger · int32Optional

Unique ID of a Language.

IsoCodestringOptional

ISO code for this Language.

NamestringOptional

Name of the Language.

FabricIdstringOptional

Fabric Language Id.

IETFCodestringOptional

IETF BCP 47 code for this language.

get/Common/Languages/{Id}
200

Success

Returns all MovieAlternateIdTypes

get

No parameters

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
MovieAlternateIdTypeResponse[]Optional
get/Common/MovieAlternateIdTypes
200

Success

List of Movie Certifications.

get

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

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
MovieCertificationResponse[]Optional
get/Common/MovieCertifications
200

Success

List of Movie Genres.

get

List of all movie genres used in the API.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
DbMovieGenre[]Optional
get/Common/MovieGenres
200

Success

List of Movie Release Types

get

No parameters

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
MovieReleaseTypeResponse[]Optional
get/Common/MovieReleaseTypes
200

Success

List of Originating Networks.

get

Returns a list of originating networks associated with shows in the IVA database.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
OriginatingNetworkResponse[]Optional
get/Common/OriginatingNetworks/
200

Success

List of External Id Types

get

No parameters

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
ShowAlternateIdTypeResponse[]Optional
get/Common/ShowAlternateIdTypes
200

Success

List of Show Certifications.

get

List of Show Certifications and definitions.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
DbShowCertification[]Optional
get/Common/ShowCertifications
200

Success

List of Show Genres.

get

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

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
DbShowGenre[]Optional
get/Common/ShowGenres
200

Success

List of Show Release Types

get

No parameters

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
ShowReleaseTypeResponse[]Optional
get/Common/ShowReleaseTypes
200

Success

List of Tags (with paging).

get

Paged list of all tags used in the API.

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
200

Success

application/json
TagResponse[]Optional
get/Common/Tags/
200

Success

List of Trend Sources.

get

List of Trend Sources.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
TrendSourceResponse[]Optional
get/Common/TrendSources
200

Success

List of Video Types.

get

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

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json
VideoTypeResponse[]Optional
get/Common/VideoTypes/
200

Success

Last updated