{"id":714,"date":"2017-04-21T15:33:22","date_gmt":"2017-04-21T15:33:22","guid":{"rendered":"http:\/\/live.ecd-demo.com\/apihelp\/?page_id=714"},"modified":"2025-07-21T17:43:17","modified_gmt":"2025-07-21T17:43:17","slug":"faceted-search","status":"publish","type":"page","link":"https:\/\/apihelp.ecd-demo.com\/index.php\/documentation\/faceted-search\/","title":{"rendered":"Faceted Search"},"content":{"rendered":"

Search for content instance documents<\/h3>\n

The search request returns content instance documents matching search criteria. The results are filtered, sorted, grouped, and annotated. In addition to the search engine, which returns assets matching the search query, Search also supports search
\nphrase suggestions. Based on an (incomplete) search term which suggests complete search phrases together with the asset attribute name the phrase was found in.<\/p>\n

Search for a keyword<\/h4>\n
GET https:\/\/<base-url>\/stores-active\/contentInstance\/event\/search-phrase\/big%20bang\n<\/code><\/pre>\n
Retrieve the specified number of search phrase suggestions from a limited set of attributes<\/strong><\/p>\n
GET https:\/\/<base-url>\/stores-active\/contentInstance\/event\/search-phrase\/gir?numberOfResults=3&attributes=[\"searchableTitles.*\"]\n<\/code><\/pre>\n
Search for a program title<\/h4>\n
GET https:\/\/<base-url>\/stores-active\/contentInstance\/event\/search?query=terminator&attributes=[\"searchableTitles.*\"]\n<\/code><\/pre>\n
Search for a contributor<\/h4>\n
GET  https:\/\/<base-url>\/stores-active\/contributor\/search?query=spacey&annotation={\"unconditionalAttributes\":[\"contributorNames\",\"contributorId\"]}\n<\/code><\/pre>\n
\n
The Search Engine offers intelligent free text search capabilities among the assets in the asset store. Autocompletion and auto-correction are supported.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
<\/th>\n<\/th>\n<\/tr>\n<\/thead>\n
search for an exact word or phrase<\/td>\nUse double quotes “” to search for an exact word or set of words.<\/td>\n<\/tr>\n
Include a word<\/td>\nAdd a plus before the word to indicate that the word is mandatory<\/td>\n<\/tr>\n
Exclude a word<\/td>\nAdd a dash \u2013 before the word to exclude all assets containing the word<\/td>\n<\/tr>\n
wildcards<\/td>\n* and ? wildcards represent arbitrary terms or characters, respectively<\/td>\n<\/tr>\n
logical operators<\/td>\nAND, OR, NOT, note that logical operators have to be in CAPITAL letters<\/td>\n<\/tr>\n
parentheses<\/td>\n( and ) may be used to control the sequence of evaluation<\/td>\n<\/tr>\n
search within specific fields<\/td>\nUse the asset attribute name followed by a colon and the desired asset attribute value to search in specific fields only. In case of hierarchical asset attributes the dot notation is supported (e.g. persons.actor:eastwood)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n
Search for an exact word or phrase<\/h4>\n
Seach for exact word or phrase in the store. This will help to find set of words or find the exact word in the store.<\/p>\n
GET https:\/\/<base-url>\/stores-active\/contentinstance\/program\/search?filter={\"operator\":\"and\",\"criteria\":[{\"operator\":\"exists\",\"term\":\"images\"}]}&annotation={\"unconditionalAttributes\":[\"searchableTitles\"]}&query=\\\"two\\\"&attributeWeights={\"searchableTitles.value.*\":1}\n<\/code><\/pre>\n
GET https:\/\/<base-url>\/stores-active\/contentinstance\/program\/search?filter={\"operator\":\"and\",\"criteria\":[{\"operator\":\"exists\",\"term\":\"images\"}]}&annotation={\"unconditionalAttributes\":[\"searchableTitles\"]}&query=\\\"game of thrones\\\"&attributeWeights={\"searchableTitles.value.*\":1}\n<\/code><\/pre>\n
Include a word or Exclude a word<\/h4>\n
Add a plus(+) before the word to indicate that the word is mandatory. Add a dash \u2013 before the word to exclude all assets containing the word. This will help to include combination of words and exclude more words.<\/p>\n
GET https:\/\/<base-url>\/\/stores-active\/contentinstance\/event\/search?filter={\"operator\":\"and\",\"criteria\":[{\"operator\":\"exists\",\"term\":\"images\"}]}&annotation={\"unconditionalAttributes\":[\"searchableTitles\"]}&query='(at+Bucks)'&attributeWeights={\"searchableTitles.value.en\":1}&numberOfResults=20\n<\/code><\/pre>\n
GET https:\/\/<base-url>\/stores-active\/contentinstance\/program\/search?filter={\"operator\":\"and\",\"criteria\":[{\"operator\":\"exists\",\"term\":\"images\"}]}&annotation={\"unconditionalAttributes\":[\"searchableTitles\"]}&query=-the post&attributeWeights={\"searchableTitles.value.*\":1}&numberOfResults=20\n<\/code><\/pre>\n
Wildcards<\/h4>\n
Wild card search is a pattern kind of search. * and ? wildcards represent arbitrary terms or characters, respectively.<\/p>\n
    \n
  • ? matches exactly one non-space character<\/li>\n
  • \n
      \n
    • matches zero or more non-space characters<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
      For example, he* will match any word starting with he, such as he, her, help, hello, helicopter, and so on. On the other hand, he? will only match three-letter words starting with he, such as hem, hen, and so on.<\/p>\n
      You can use this at the end of words as well. I\u2019m search for the word which ends with ville.<\/p>\n
      GET https:\/\/<base-url>\/stores-active\/contentinstance\/program\/search?filter={\"operator\":\"and\",\"criteria\":[{\"operator\":\"exists\",\"term\":\"images\"}]}&annotation={\"unconditionalAttributes\":[\"searchableTitles\"]}&query=*ville&attributeWeights={\"searchableTitles.value.en\":1}&numberOfResults=20\n<\/code><\/pre>\n
      ? aslo works in the same way but the length is just. May be used for plural words. The below url search for the with the query \u2018fun?y\u2019 (the results will have funny or funky in the titles\u201d<\/p>\n
      GET https:\/\/<base-url>\/stores-active\/contentinstance\/event\/search?filter={\"operator\":\"and\",\"criteria\":[{\"operator\":\"exists\",\"term\":\"images\"}]}&annotation={\"unconditionalAttributes\":[\"searchableTitles\"]}&query=fun?y&attributeWeights={\"searchableTitles.value.*\":1}&numberOfResults=20\n<\/code><\/pre>\n
      Search within specific fields<\/h4>\n
      Use the asset attribute name followed by a colon and the desired asset attribute value to search in specific fields only. In case of hierarchical asset attributes the dot notation is supported (e.g.persons.actor:eastwood)
      \nThe below url is used to search exact word \u201cfriends\u201d in the searchableTitles.value.en<\/p>\n
      GET https:\/\/<base-url>\/stores-active\/contentInstance\/program\/search?query=searchableTitles.value.en:two&annotation={\"unconditionalAttributes\": [\"searchableTitles\"]}\n<\/code><\/pre>\n
      AND, OR, NOT, note that logical operators have to be in CAPITAL letters<\/h4>\n
      This will be helpful to combine two or more about search. The operators are used to combine the above search types.<\/p>\n
      GET https:\/\/<base-url>\/stores-active\/contentInstance\/program\/search?query=(searchableTitles.value.en:blue)AND(NOT(searchableTitles.type:episode))&numberOfResults=5&annotation={\"unconditionalAttributes\": [\"searchableTitles\"]}\n<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
      Search for content instance documents The search request returns content instance documents matching search criteria. The results are filtered, sorted, grouped, and annotated. In addition to the search engine, which returns assets matching the search query, Search also supports search phrase suggestions. Based on an (incomplete) search term which suggests complete search phrases together with […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":279,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-714","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/714","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/comments?post=714"}],"version-history":[{"count":1,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/714\/revisions"}],"predecessor-version":[{"id":1519,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/714\/revisions\/1519"}],"up":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/279"}],"wp:attachment":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/media?parent=714"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}