What is the Results API? | Questionmark

What is the Results API?

Applies to the following products: 
Questionmark OnDemand
Questionmark Perception
Applies to the following Perception versions: 
Perception 5.7

Based on the Open Data (OData) protocol, Questionmark's Results API is a REST-ful data service that can be used to retrieve result data from a user's Results Warehouse. To learn more about the Open Data protocol, which is based on the popular Atom protocol, please refer to odata.org. Data services like Questionmark's Results API is interacted with via clients, such as a web browser or tools like PowerPivot for Excel 2010, Excel 2013, and Tableau, among others. Through a client, a user makes a request to the data service, and the data service processes that request and returns an appropriate response. You can use just about any client to access the Results API as long as it can make HTTP requests and parse XML responses.

With our Results API, you access feeds, which contain entries, which in turn contain properties. You access feeds by URL paths (the part of a URL after the host name). Responses from the Results API include links that tie related entries together. 

Questionmark's Results API uses the Microsoft implementation of OData and thus supports all the commands found at the following location:

The Results API OData feeds are designed to return specific datum and granular subsets of data. When querying multiple data in a feed, querying multiple feeds simultaneously, or querying against the content in a variable that is not a key field for the feed, the Results API may timeout. Users are encouraged to design queries to use specific key values.