Accessing the Results API via a web browser | Questionmark

Accessing the Results API via a web browser

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

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. Questionmark encourages users to design queries to use specific key values.

This section explains how to retrieve results data from the Results API using a web browser (in this case, Internet Explorer) as the client.

  1. Enter the address of the Results API service for the Questionmark account you want to access the results data for. In this example, we are going to access an OnDemand account:

  2. Enter your username and password to authenticate and log into the Results API.
  3. If the supplied credentials are valid, you will be taken to the following screen, a service document that lists all the top-level feeds that can be accessed:

  4. Use the feed paths and the links contained within individual entries to access the data in the Results Warehouse. The general process is outlined in the What is the Results API? section. To access a feed, append the feed path to the base URL. For example, to view the Participants feed, enter: 

    https://ondemand.questionmark.com/<customer ID>/odata/Participants/

For a list of the fourteen feeds that can be accessed through the Results API and information on each individual feed, please refer to the section Results API feeds.

The Assessments, Choices, and Questions feeds include default records that are used in instances when data from certain records does not have an assigned value. If you're creating reports from records in these three feeds, you will see one more record than you expect, this extra record being the default record. You can filter out the default record if you choose to so that you see the expected number of records in any reports you generate. The individual pages for the Assessments, Choices, and Questions feeds display the default records so you know which record to filter when generating reports.