REST API

RESTful API

Build useful dashboards or capture measurable and contextual data points related to team experiences

License

Please read our policy on acceptable use and change management.

Read & Accept →

Support

We aim for our API to be useful and easy. Please lodge your issues or suggestions via Github.

Github Issues →

Changelog

The register of incremental changes to API versions. 

Read →

Example Implementation

  • You can utilize any REST API utility for making calls to our API
  • Here is one implementation that leverages Google Appscript to get the data into the Googlesheet
  • Library that orchestrates the calls to Neelix endpoints (feel free to fork)
  • Example Googlesheet with embedded Appscript
  • Supporting Toaster library for UI notifications

Get Started

Pre-requisites

Access Permissions Model

  • Option 1 : A token created for a given subscription entity by a "Maintenance" member of that entity
  • grants access to any records belonging to any space sponsored by that subscription entity, and would be able to create new experiences for all of those same spaces.
  • Option 2 : A token created by a "Developer" member of the subscription entity
  • the access is more restrictive
  • token created by a "Developer" for a given subscription entity would only have access to the specific subset of sponsored spaces that have been explicitly added to their "allowed" by a "Maintenance" user of the subscription entity.

Adding Developers to Existing Space Subscription

  • Maintenance user of the subscription should go to Account Settings
  • Click on "Subscriptions"
  • Click on "Edit" and select "Developers" option
  • Link a user as a "Developer" and specify which spaces are allowed

Create API Token

  • Developer should go to Account Settings
  • Click on "API Access"
  • Click on "Create New Access API Token"

Developer Helper Tool

  • Neelix.IO UI provides developer view for obtaining ids of objects that may be needed for testing. Read more.

Github Actions

The GitHub Action script serves as an invaluable tool for your development team, enabling to seamlessly automate joint assessment  coding practices.
Learn More
Share by: