There are multiple APIs that are available to your institution. Below is a brief description of each of these APIs. Advance technical documentation is located here.
Detailed information about each instance of assessment collection as-well-as non-cognitive factor and forecast scores.
Defined instruments that quantify the non-cognitive state of respondents.
Creates or returns notation categories for your institution. Includes details of the alert, if the student can view it or not, which audience the alert is visible to, and a category for the alert. This information can also be sent.
Statistics that illuminate the activity and attention around each student.
Defined data sources that can be used to create recurring student success notations on student records.
Basic information about a person.
Success Network: Staff & Faculty that are assigned to a student based on their role and/or responsibilities as student success interventionists or support.
Creates or returns open alerts for a user. Includes details of the alert, if the student can view it or not, which audience the alert is visible to, and a category for the alert. This information can also be sent.
Success Data Insight Definition
Creates and returns all data insight definitions. Includes the name of the insight definition,the audience type, if it is view-able by students, and if data insights created by this data insight definition are created as alerts.
Success Data Insights
Returns all data insights that were created within a specified date range for a user. Includes details of the insight, when the insight was created, comments in response to the alert, and the category for the alert.
Creates or returns all encouragements for a specific student.
Creates or returns update for a user. Includes details of the update, if the student can view it or not, which audience the update is visible to, and a category for the update.