The REST API provides you with an integration point into your Course Evaluations & Surveys account for accessing and extracting, creating and modifying data within the system, all of which is accomplished externally from our main user interface, using your own programs and scripting.
NOTE:
- Although we provide access through the REST API, use of the REST API is a self-service feature and will require a developer with relevant knowledge and skills within your organization.
- Watermark Course Evaluations & Surveys Support does not provide training in the use of REST API. However, please contact Support by logging into the Help Center if you are having a technical issue with a function.
REST API key functionality includes:
- Ability to extract survey raw data results directly via the API. Customers can integrate with the API to also extract metadata of interest along with the raw data results, for instance, desired course and user metadata, and survey question metadata. As well, customers can populate an unlimited number of additional custom user and course data fields in the system, which can also be extracted along with the raw data results.
- REST API allows customers to add, modify, and delete courses and users in projects. In addition to the standard course and user fields (students and instructors), customers can add an unlimited number of additional custom fields via the API for your course, students, and instructors. The REST API also allows creation and modification of Projects. Also supported in the REST API, customers can use the API for real-time monitoring of respondents and non-respondents within projects, and access all relevant course and user metadata as desired when doing so. This can be useful if you wish to pull this information in real-time (vs just at the end of the project) directly into another system while the project is still open.
- Create or modify Hierarchy Building and Hierarchy Mapping. You can create, edit, or remove items in your Hierarchy Builder and Hierarchy Mapper using the REST API.
A full list of REST API endpoints is available in Course Evaluations & Surveys user interface under Account > API (section) > Documentation. REST API documentation is only viewable by CES Administrators.
To use the REST API feature, the CES Administrator will first need to enable a token. The CES Administrator can enable their token by navigating to Account > API > REST API Token and toggling the token to ON. Each CES Administrator can enable their own unique token if they wish. Tokens can also be deleted if they are no longer needed. Tokens can also be regenerated if a previous token was compromised and a new token needs to be created in its place. Each new token issued will have a unique value, and deleted tokens will remain inactive.