REST API

Search Endpoints

REST API documentation for searching The Entertainment Graph®.

Searches across all Content.

Copy
http
https://api.mediahound.com/1.3/search/all/QUERY_STRING

Overview

Search allows your User to find Content from across The Entertainment Graph using plain language.

If you need to limit results, you can filter by Content type. For example, multiple Types are allowed if you want to filter search results to TV Shows or Movies.

Since the search query is in the URL, you need to URL encode the string appropriately.

Parameters

PropertyDescription
queryRequired String.
access_tokenOptional String. See Authentication.
pageSizeOptional Integer. If you enter nothing, this parameter will default to 10.
typesOptional Array. The content types to filter by. If no types are provided, all Content types are considered in the search.

The allowed types are:

  • movie
  • track
  • album
  • showseries
  • showseason
  • showepisode
  • book
  • game
  • collection
  • user
  • contributor

Response

Copy
JSON
{
  "content": [
    {
      "object": {
        "mhid": String,
        "altId": String,
        "name": String,
        "keyContributors" : KEY_CONTRIBUTORS_OBJECT,
        "primaryImage" : IMAGE_OBJECT,
        "secondaryImage" : IMAGE_OBJECT,
        "primaryGroup" : MEDIA_OBJECT
      },
      "context":{}
  ],
  "pagingInfo": PAGING_INFO_OBJECT
}

SDK Usage

Copy
JS
import { search } from 'houndjs';

// Search across all types
search.all({
  searchTerm: 'query'
});

// Search across only movies or showseries
search.all({
  searchTerm: 'query',
  scopes: ['movie', 'showseries']
});

For more on the JavaScript SDK, please see the HoundJS documentation.