Search requests are made by performing an HTTP GET request for a URL of the form:
http://api.ads.oneriot.com/search
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.2 to specify that the request be interpreted and response be generated according to this documentation.
- appId
- your assigned application identifier
Example:
http://api.ads.oneriot.com/search?appId=<yourAppId>&version=1.1&format=XML
where <yourAppId> is replaced with your assigned application identifier
There is no hard throttle on this service, however results are cached for 3 minutes and we recommend that partners do the same on their end.
- Cache-control headers to indicate this to clients.
- The server response will contain an XML-formatted set of one to 10 featured-result elements.
The format is as follows:
- [application version]
- [time the result set was generated]
- [amount of time the client should cache the results]
- [short version of the target URL for display]
- [page snippet]
- [source of content]
- [link to the source logo]
- [target URL for the end user to follow]
- [impression tracking link]
Do not remove the tracking and redirect URLs when presenting results. This allows OneRiot to track both impressions and click-through.