API Reference

The v1.0 version of the implementation is restricted to surveys and responses. The v2.0 version mainly adds participant functionality. However, various existing v1.0 endpoints have been changed. These changes will be listed inside [ ] brackets.

Please note that from Monday 5th December 2022 usage of the API becomes chargeable. The charge is that 0.1 unit will be consumed each time a survey response is delivered by the API.  This applies if the same survey response is delivered by the API multiple times. The survey responses are delivered using the Get Survey Responses endpoint.

List of API endpoints in v2.0

EndpointDescription
Get Survey List Returns a list of surveys that are accessible by the user.
Get Survey Returns the details for a specific survey ID.
Get Survey Variables Returns the details for a specific survey ID.
Get Survey Variable Returns the details for a specific variable ID.
Get Survey Responses Gets the responses for a specific survey ID.
Please note that from Monday 5th December 2022 usage of the API becomes chargeable. When one survey response is delivered by the API, 0.1 unit will be consumed.  The survey responses are delivered using the Get Survey Responses endpoint.
Get User Info Returns information for the authenticated user.
Get Participant List Returns a list of participants for a survey.
Get Participant Returns the details for a specific participant in a survey.
Add Participant Add a new participant to a survey.
Update Participant Update an existing participant of a survey.
Delete Participant Delete a participant from a survey.
Get Participants Subjects Returns a list of subjects for a participant of a survey.
Get Participant Subject Returns the details of a specific subject for a participant of a survey.
Add Participant Subject Add a new subject to a participant of a survey.
Update Participant Subject Update an existing subject for a participant of a survey.
Delete Participant Subject Delete a subject from a participant of a survey.

Updated
Contents

Cookie settings

You can decide which cookies you wish to allow and can change your settings at any time. You cannot prevent our use of strictly necessary cookies. For more information about the cookies we use, please see our cookie policy.

With the slider, you can enable or disable different types of cookies:

This website will:

  • Remember which cookies group you accepted
  • Strictly necessary: remember your cookie permission setting
  • Strictly necessary: allow session cookies
  • Strictly necessary: authenticate that you are logged into your user account

This website won't:

  • Functionality: remember your online chat ID
  • Analytics: keep track of your visited pages and interaction taken
  • Analytics: keep track of your location and region based on your partial IP number
  • Analytics: keep track of the time spent on each page and the videos you watch
  • Analytics: identify the device you are using
  • Targeting: identify if you contacted or called us as a result of one of our adverts

This website will:

  • Remember which cookies group you accepted
  • Strictly necessary: remember your cookie permission setting
  • Strictly necessary: allow session cookies
  • Strictly necessary: authenticate that you are logged into your user account
  • Functionality: remember your online chat ID

This website won't:

  • Analytics: keep track of your visited pages and interaction taken
  • Analytics: keep track of your location and region based on your partial IP number
  • Analytics: keep track of the time spent on each page and the videos you watch
  • Analytics: identify the device you are using
  • Targeting: identify if you contacted or called us as a result of one of our adverts

This website will:

  • Remember which cookies group you accepted
  • Strictly necessary: remember your cookie permission setting
  • Strictly necessary: allow session cookies
  • Strictly necessary: authenticate that you are logged into your user account
  • Functionality: remember your online chat ID
  • Analytics: keep track of your visited pages and interaction taken
  • Analytics: keep track of your location and region based on your partial IP number
  • Analytics: keep track of the time spent on each page and the videos you watch
  • Analytics: identify the device you are using

This website won't:

  • Targeting: identify if you contacted or called us as a result of one of our adverts

This website will:

  • Remember which cookies group you accepted
  • Strictly necessary: remember your cookie permission setting
  • Strictly necessary: allow session cookies
  • Strictly necessary: authenticate that you are logged into your user account
  • Functionality: remember your online chat ID
  • Analytics: keep track of your visited pages and interaction taken
  • Analytics: keep track of your location and region based on your partial IP number
  • Analytics: keep track of the time spent on each page and the videos you watch
  • Analytics: identify the device you are using
  • Targeting: identify if you contacted or called us as a result of one of our adverts

This website won't:

Save & Close