Featured Entity API 1.1

VideoSurf algorithms select entities to feature on our homepage and elsewhere on our site. They are people or topics that are currently featured in the news or blogs. The list is updated very frequently, and the process is automatic. Use this service to retrieve a current list of these entities.

URL

• The URL where you can access this API looks like:
  http://apis.videosurf.com/featured_entities/v1.1/

Authentication

• Each use of any VideoSurf API is subject to the Terms Of Use and requires you to provide a valid client_id and client_key
• client_id - A human readable client identifier. Please pick something short and descriptive.
  • Required
  • Type: String
  • Example: client_id=your_domain
• client_key - This is an authorization token issued to you by VideoSurf. Obtain one here.
  • Required
  • Type: String
  • Example: client_key=900d77b8e40e60f0113dccc2973f2ed1

Inputs

• page - Which page of results to return.
  • Optional
  • Type: Number
  • Default: 1
  • Maximum: 5
  • Example: page=2
• num_per_page - How many entities to return per page.
  • Optional
  • Type: Number
  • Default: 20
  • Maximum: 20
  • Example: num_per_page=5
• callback - An optional callback function to wrap the response. This is useful for client side scripting with a technique called JSONP. This will only be utilized if the output_format is json.
  • Optional
  • Type: String
  • Example: callback=my_fn - This will result in a response that looks like this: my_fn({ json goes here });
• output_format - Format of the response, either as a JSON object or serialized PHP.
  • Optional
  • Type: String
  • Default: json
  • Possible Values:

    json	JSON object (more info on json)
    php	Serialized PHP (more info on serialized php)

  • Example: output_format=php

Output

• total_results - The total number of entities returned
• entities - A dictionary mapping each resulting entity to information about that entity
  • entity_id - Maps to an array of information about the entity, containing:
    • entity_id - A numeric identifier for the matching entity
    • title - The title of this entity
    • thumbnail - The URL for the primary thumbnail for this entity
    • topic_page_url - The URL for the VideoSurf topic page for this entity