OBJECT

SearchQuery

link GraphQL Schema definition

  • type SearchQuery {
  • # Arguments
  • # index: [Not documented]
  • # must: [Not documented]
  • # must_not: [Not documented]
  • # should: [Not documented]
  • # q: [Not documented]
  • # fq: [Not documented]
  • # page: [Not documented]
  • # page_size: [Not documented]
  • # sort: [Not documented]
  • # type: [Not documented]
  • # from: [Not documented]
  • # to: [Not documented]
  • # highlight: [Not documented]
  • # facet: [Not documented]
  • # bbox: [Not documented]
  • # radius: [Not documented]
  • # spotlight: [Not documented]
  • query(
  • index: String!,
  • must: BoolFilter,
  • must_not: BoolFilter,
  • should: BoolFilter,
  • q: String,
  • fq: String,
  • page: Int,
  • page_size: Int,
  • sort: SortOrder,
  • type: [String],
  • from: Date,
  • to: Date,
  • highlight: Boolean,
  • facet: [String],
  • bbox: BoundingBox,
  • radius: Radius,
  • spotlight: Boolean
  • ): QueryResponse
  • # Arguments
  • # index: [Not documented]
  • # must: [Not documented]
  • # must_not: [Not documented]
  • # should: [Not documented]
  • # q: [Not documented]
  • # fq: [Not documented]
  • # page: [Not documented]
  • # page_size: [Not documented]
  • # sort: [Not documented]
  • # type: [Not documented]
  • # from: [Not documented]
  • # to: [Not documented]
  • # highlight: [Not documented]
  • # facet: [Not documented]
  • # bbox: [Not documented]
  • # radius: [Not documented]
  • # spotlight: [Not documented]
  • prefix(
  • index: String!,
  • must: BoolFilter,
  • must_not: BoolFilter,
  • should: BoolFilter,
  • q: String,
  • fq: String,
  • page: Int,
  • page_size: Int,
  • sort: SortOrder,
  • type: [String],
  • from: Date,
  • to: Date,
  • highlight: Boolean,
  • facet: [String],
  • bbox: BoundingBox,
  • radius: Radius,
  • spotlight: Boolean
  • ): PrefixResponse
  • # Arguments
  • # index: [Not documented]
  • # must: [Not documented]
  • # must_not: [Not documented]
  • # should: [Not documented]
  • # q: [Not documented]
  • # fq: [Not documented]
  • # page: [Not documented]
  • # page_size: [Not documented]
  • # sort: [Not documented]
  • # type: [Not documented]
  • # from: [Not documented]
  • # to: [Not documented]
  • # highlight: [Not documented]
  • # facet: [Not documented]
  • # spotlight: [Not documented]
  • sitesearch(
  • index: String!,
  • must: BoolFilter,
  • must_not: BoolFilter,
  • should: BoolFilter,
  • q: String,
  • fq: String,
  • page: Int,
  • page_size: Int,
  • sort: SortOrder,
  • type: [String],
  • from: Date,
  • to: Date,
  • highlight: Boolean,
  • facet: [String],
  • spotlight: Boolean
  • ): SitesearchResponse
  • # Arguments
  • # index: [Not documented]
  • # must: [Not documented]
  • # must_not: [Not documented]
  • # should: [Not documented]
  • # q: [Not documented]
  • # fq: [Not documented]
  • # page: [Not documented]
  • # page_size: [Not documented]
  • # sort: [Not documented]
  • # type: [Not documented]
  • # from: [Not documented]
  • # to: [Not documented]
  • # highlight: [Not documented]
  • # facet: [Not documented]
  • # spotlight: [Not documented]
  • disneysearch(
  • index: String!,
  • must: BoolFilter,
  • must_not: BoolFilter,
  • should: BoolFilter,
  • q: String,
  • fq: String,
  • page: Int,
  • page_size: Int,
  • sort: SortOrder,
  • type: [String],
  • from: Date,
  • to: Date,
  • highlight: Boolean,
  • facet: [String],
  • spotlight: Boolean
  • ): DisneySearchResponse
  • # Arguments
  • # index: [Not documented]
  • # must: [Not documented]
  • # must_not: [Not documented]
  • # should: [Not documented]
  • # q: [Not documented]
  • # fq: [Not documented]
  • # page: [Not documented]
  • # page_size: [Not documented]
  • # sort: [Not documented]
  • # type: [Not documented]
  • # from: [Not documented]
  • # to: [Not documented]
  • # highlight: [Not documented]
  • # facet: [Not documented]
  • # bbox: [Not documented]
  • # radius: [Not documented]
  • # spotlight: [Not documented]
  • bucket(
  • index: String!,
  • must: BoolFilter,
  • must_not: BoolFilter,
  • should: BoolFilter,
  • q: String,
  • fq: String,
  • page: Int,
  • page_size: Int,
  • sort: SortOrder,
  • type: [String],
  • from: Date,
  • to: Date,
  • highlight: Boolean,
  • facet: [String]!,
  • bbox: BoundingBox,
  • radius: Radius,
  • spotlight: Boolean
  • ): TopFoundHitsResponse
  • # Returns all bookmarks for a user matching the contentIds provided. The media for
  • # the contentIds will be provided along with the Bookmark. The profileId of the
  • # user is determined from the JWT Token in the request.
  • #
  • # Arguments
  • # contentIds: [Not documented]
  • BookmarksWithMedia(contentIds: [ID!]!): BookmarkMediaResponse
  • # Returns all the bookmarks belonging to a particular User. The profileId of the
  • # user is determined from the JWT Token in the request.
  • #
  • # Arguments
  • # contentIds: [Not documented]
  • Bookmarks(contentIds: [ID!]): [BookmarkHit]
  • # Arguments
  • # type: [Not documented]
  • # page_size: [Not documented]
  • # page: [Not documented]
  • Watchlist(type: [String], page_size: Int, page: Int): WatchlistMediaResponse
  • # Retrieve live, onAir, linear, or once-live video metadata sourced from EPG
  • # Metadata Service.
  • #
  • # Arguments
  • # startDate: Start date for a schedule by date range. Must be
  • # accompanied by endDate. If both are present, scheduled airings will be returned.
  • # ISO8601 format (2017-01-23T21:13:31Z)
  • # endDate: End date for a schedule by date range. Must be
  • # accompanied by startDate. If both are present, scheduled airings will be
  • # returned. ISO8601 format (2017-01-23T21:13:31Z)
  • # onAir: If present and there are no Start and End dates,
  • # retrieve only airings that are currently onAir.
  • # upcoming: If present and there are no Start and End dates,
  • # retrieve only airings will be onAir in the future.
  • # genre: Genre used to filter the airing data. Required if you're
  • # filtering based on genre for onAir or scheduled metadata.
  • # category: Filter Airing(s) by category. Category is the same as
  • # genre
  • # programType: Filter by one or more program type(s). Required if
  • # you're filtering based on program type for onAir or scheduled metadata.
  • # partnerProgramIds: Filter by one or more partnerProgramIds, a
  • # unique ID provided by the partner which is consistent between Airings and VOD
  • # assets related to those Airings.
  • # channelId: Filter by ChannelId and retrieve onAir airings if
  • # partnerProgramIds is absent.
  • # contentId: Filter by ContentId and retrieve airings if
  • # partnerProgramIds and channelId are both absent.
  • # groupingId: Retrieve Airings that have this groupingId value.
  • # groupingId is an ID used to group Airings together by some common criteria (e.g.
  • # media related to a Eurosport Event Page).
  • # mediaId: Provide a mediaId to filter Airings by
  • # endsAfter: Ends After is used in conjunction with
  • # partnerEventId and is used to filter airing data. ISO8601 format
  • # (2017-01-23T21:13:31Z)
  • # languages: For Airing fields that contain multiple
  • # language-specific objects (e.g. titles), filter to only data that matches one of
  • # these language values, in priority order. The server will also perform an alt
  • # languages lookup for each provided value, checking for languages that roll up to
  • # the same ISO macro-language. If no matching content is found, the first item in
  • # the list will be used. If this argument is not provided, no filtering is
  • # performed.
  • # channelCallsigns: Filter your results by Airings that match one
  • # of the Channel Callsigns provided in this list.
  • # page: The index of the page of results you would like.
  • # (Defaulted to 0)
  • # pageSize: The total number of results that are returned on each
  • # 'page' of results. (Defaulted to 500)
  • Airings(
  • startDate: String,
  • endDate: String,
  • onAir: Boolean,
  • upcoming: Boolean,
  • genre: String,
  • category: String,
  • programType: String,
  • partnerProgramIds: [ID],
  • channelId: ID,
  • contentId: ID,
  • groupingId: ID,
  • mediaId: ID,
  • endsAfter: String,
  • languages: [String],
  • channelCallsigns: [String],
  • page: Int,
  • pageSize: Int
  • ): [Airing]
  • # Arguments
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • CategoryAll(page: Int, pageSize: Int): [Category]
  • # Arguments
  • # contentId: [Not documented]
  • CategoryByContentId(contentId: ID!): Category
  • # Arguments
  • # sport: [Not documented]
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • CategoryBySport(sport: String!, page: Int, pageSize: Int): [Category]
  • # Arguments
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • ChannelAll(page: Int, pageSize: Int): [Channel]
  • # Arguments
  • # contentId: [Not documented]
  • ChannelByContentId(contentId: ID!): Channel
  • CollectionAll: [Collection]
  • # Arguments
  • # contentId: [Not documented]
  • CollectionByContentId(contentId: ID!): Collection
  • # Arguments
  • # contentId: [Not documented]
  • ConfigurationJsonByContentId(contentId: ID!): ConfigurationJson
  • # Arguments
  • # resourceKey: [Not documented]
  • ConfigurationJsonByResourceKey(resourceKey: ID!): ConfigurationJson
  • # Arguments
  • # contentId: [Not documented]
  • ConfigurationStructuredByContentId(
  • contentId: ID!
  • ): ConfigurationStructured
  • # Arguments
  • # contentId: [Not documented]
  • DimensionByContentId(contentId: ID!): Dimension
  • # Arguments
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • EventPageAll(page: Int, pageSize: Int): [EventPage]
  • # Arguments
  • # contentId: [Not documented]
  • EventPageByContentId(contentId: ID!): EventPage
  • # Arguments
  • # language: [Not documented]
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • EventPageByLanguage(
  • language: String!,
  • page: Int,
  • pageSize: Int
  • ): [EventPage] @deprecated( reason: "Use `EventPageAll`" )
  • # Arguments
  • # contentId: [Not documented]
  • FieldOptionByContentId(contentId: ID!): FieldOption
  • # Arguments
  • # contentId: [Not documented]
  • KeyValueByContentId(contentId: ID!): KeyValue
  • # Arguments
  • # contentId: [Not documented]
  • ListByContentId(contentId: ID!): List
  • # Arguments
  • # title: [Not documented]
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • ListByTitle(title: String!, page: Int, pageSize: Int): List
  • # Arguments
  • # contentId: [Not documented]
  • MasterCutByContentId(contentId: ID!): MasterCut
  • # Arguments
  • # partnerProgramIds: Filter media by one or more Partner Program
  • # IDs
  • # groupingId: Filter by a groupingId
  • # genre: Filter by genre/category (synonymous
  • # programType: Filter media by a particular programType
  • # mediaId: Filter by a particular mediaId
  • # languages: Filter media metadata by a language or set of
  • # languages in defaulting order from left (highest) to right (lowest)
  • # page: Provide a page number to indicate the starting point of
  • # the result set. By default page starts at 0.
  • # pageSize: The size of your result set. By default, this is 10.
  • Media(
  • partnerProgramIds: [ID],
  • groupingId: ID,
  • genre: String,
  • programType: String,
  • mediaId: ID,
  • languages: [String],
  • page: Int,
  • pageSize: Int
  • ): [MediaList]
  • # Arguments
  • # contentId: [Not documented]
  • MediaAssetByContentId(contentId: ID!): MediaAsset
  • # Arguments
  • # contentId: [Not documented]
  • PageByContentId(contentId: ID!): Page
  • # Arguments
  • # resourceKey: [Not documented]
  • PageByResourceKey(resourceKey: ID!): Page
  • # Arguments
  • # contentId: [Not documented]
  • PhotoAssetByContentId(contentId: ID!): PhotoAsset
  • # Arguments
  • # contentId: [Not documented]
  • PhotoByContentId(contentId: ID!): Photo
  • # Arguments
  • # contentId: [Not documented]
  • PhotoTemplateByContentId(contentId: ID!): PhotoTemplate
  • # Arguments
  • # contentId: [Not documented]
  • # collectionContentId: [Not documented]
  • # seriesContentId: [Not documented]
  • postplay(contentId: ID!, collectionContentId: ID, seriesContentId: ID): PostPlayResponse
  • # Arguments
  • # channelIds: [Not documented]
  • # startDate: [Not documented]
  • # endDate: [Not documented]
  • # onAir: [Not documented]
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • Schedule(
  • channelIds: [String],
  • startDate: String,
  • endDate: String,
  • onAir: Boolean,
  • page: Int,
  • pageSize: Int
  • ): [ChannelSchedule]
  • SeasonAll: [Season]
  • # Arguments
  • # contentId: [Not documented]
  • SeasonByContentId(contentId: ID!): Season
  • # Arguments
  • # seasonId: [Not documented]
  • SeasonBySeasonId(seasonId: String!): [Season]
  • # Arguments
  • # seasonId: [Not documented]
  • # language: [Not documented]
  • SeasonBySeasonIdAndLanguage(
  • seasonId: String!,
  • language: String!
  • ): Season @deprecated( reason: "Use `SeasonBySeasonId`" )
  • # Arguments
  • # seriesSlug: [Not documented]
  • SeasonBySeriesSlug(seriesSlug: String!): [Season]
  • # Arguments
  • # contentId: [Not documented]
  • SeasonContainerByContentId(contentId: ID!): SeasonContainer
  • # Arguments
  • # contentId: [Not documented]
  • SectionByContentId(contentId: ID!): Section
  • SeriesAll: [Series]
  • # Arguments
  • # category: [Not documented]
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • SeriesByCategory(category: String!, page: Int, pageSize: Int): [Series]
  • # Arguments
  • # contentId: [Not documented]
  • SeriesByContentId(contentId: ID!): Series
  • # Arguments
  • # genre: [Not documented]
  • SeriesByGenre(genre: String!): [Series]
  • # Arguments
  • # seriesId: [Not documented]
  • SeriesBySeriesId(seriesId: String!): [Series]
  • # Arguments
  • # seriesId: [Not documented]
  • # language: [Not documented]
  • SeriesBySeriesIdAndLanguage(
  • seriesId: String!,
  • language: String!
  • ): Series @deprecated( reason: "Use `SeriesBySeriesId`" )
  • # Arguments
  • # seriesSlug: [Not documented]
  • SeriesBySeriesSlug(seriesSlug: String!): [Series]
  • # Arguments
  • # contentId: [Not documented]
  • SeriesContainerByContentId(contentId: ID!): SeriesContainer
  • # Arguments
  • # contentId: [Not documented]
  • ShortContentByContentId(contentId: ID!): ShortContent
  • # Arguments
  • # contentId: [Not documented]
  • TemplateAspectRatioByContentId(contentId: ID!): TemplateAspectRatio
  • # Arguments
  • # contentId: [Not documented]
  • TitleAssetByContentId(contentId: ID!): TitleAsset
  • # Arguments
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • VideoAll(page: Int, pageSize: Int): [Video]
  • # Arguments
  • # category: [Not documented]
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • VideoByCategory(category: String!, page: Int, pageSize: Int): [Video]
  • # Languages filter is unused on contentId lookups
  • #
  • # Arguments
  • # contentId: [Not documented]
  • # languages: [Not documented]
  • VideoByContentId(contentId: ID!, languages: [String]): Video
  • # Arguments
  • # epgPartnerProgramId: [Not documented]
  • # languages: [Not documented]
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • VideoByEpgPartnerProgramId(
  • epgPartnerProgramId: String!,
  • languages: [String],
  • page: Int,
  • pageSize: Int
  • ): [Video] @deprecated( reason: "Use `VideoByPartnerProgramId`" )
  • # Arguments
  • # genre: [Not documented]
  • # languages: [Not documented]
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • VideoByGenre(genre: String!, languages: [String], page: Int, pageSize: Int): [Video]
  • # Arguments
  • # groupingId: [Not documented]
  • # languages: [Not documented]
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • VideoByGroupingId(
  • groupingId: String!,
  • languages: [String],
  • page: Int,
  • pageSize: Int
  • ): [Video]
  • # Arguments
  • # partnerProgramId: [Not documented]
  • # languages: [Not documented]
  • # page: [Not documented]
  • # pageSize: [Not documented]
  • VideoByPartnerProgramId(
  • partnerProgramId: String!,
  • languages: [String],
  • page: Int,
  • pageSize: Int
  • ): [Video]
  • # Arguments
  • # seasonId: [Not documented]
  • VideoBySeasonId(seasonId: String!): [Video]
  • # Arguments
  • # seriesId: [Not documented]
  • VideoBySeriesId(seriesId: String!): [Video]
  • # Arguments
  • # seriesSlug: [Not documented]
  • VideoBySeriesSlug(seriesSlug: String!): [Video]
  • # Arguments
  • # resourceKey: [Not documented]
  • videodetails(resourceKey: String!): [VideoDetail]
  • # Arguments
  • # contentIds: A list of contentIds can be provided to
  • # specifically query for a set of Videos.
  • # category: The category (sport) that you would like to filter
  • # videos by.
  • # genre: The genre (sport) that you would like to filter videos
  • # by. Genre & Category are synonymous.
  • # groupingId: Retrieve Videos filtered by a groupingId that they
  • # have been stamped with.
  • # partnerProgramIds: Filter by one or more partnerProgramIds, a
  • # unique ID provided by the partner which is consistent between Airings and VOD
  • # assets related to those Videos.
  • # seasonId: Filter Videos by a particular seasonID.
  • # seriesId: Filter Videos by a particular seriesID.
  • # seriesSlug: Filter Videos by a particular seriesSlug.
  • # mediaId: Get Videos for a particular MediaId
  • # languages: Filter the returned list of Videos by a language or
  • # set of languages in hierarchical order of preference.
  • # page: The page that the resulyou t set should begin with.
  • # Defaulted to 1.
  • # pageSize: The size of each page of results that are returned
  • # back. Defaulted to 10.
  • Videos(
  • contentIds: [String],
  • category: String,
  • genre: String,
  • groupingId: String,
  • partnerProgramIds: [ID],
  • seasonId: String,
  • seriesId: String,
  • seriesSlug: String,
  • mediaId: ID,
  • languages: [String],
  • page: Int,
  • pageSize: Int
  • ): [Video]
  • }

link Require by

This element is not required by anyone