Search requests are made by performing an HTTP GET request for a URL of the form:
http://app.oneriot.com/search?version=1.1&appId=<yourAppId>&q=<query>[&<param>=<value>...]
where <yourAppId> is replaced with your assigned application identifier, <query> is replaced with your %-encoded query string, and [&<param>=<value>...] is replaced with zero or more of the optional parameters described below, the values of which are also %-encoded as usual for URL-encoded form data.
Required parameters
- version
- the version of the API to which the request conforms, and to which the response must also conform.
- Must be set to 1.1 to specify that the request be interpreted and response be generated according to this documentation.
- appId
- your assigned application identifier
- q
- the search query for which you want results
Suggested parameters
Optional parameters
- type
- the media type of content to search for: ALL or VIDEO
- default value: ALL
- content
- the kinds of content to search for: ALL (both featured and organic content), FEATURED_ONLY (featured content), or RESULTS_ONLY (organic content)
- default value: ALL
- order
- criterion by which to order organic results: PULSE or REALTIME
- default value: PULSE
- limit
- maximum number of organic results to return
- default value: 10
- page
- the 1-based number of the page of organic results to return, where the number of organic results on each page is determined by the value of the limit parameter
- default value: 1
- format
- the format of the response: JSONP or XML
- default value: JSONP