LIME Insight exposes a REST API at the following HTTP methods and relative URIs.

Display API

GET /api/viewData/{queriedDate} Returns the data needed to display configured insights for a queried date. The response JSON contains the following:

license: {…} A license object that contains the license state and the number of trial days left.

coworkers: […] A list of all available coworkers.

groups: […] A list of all available groups.

insights: […] A list of InsightViewModel trees available from the end of the queried month and one year back.

GET /api/viewData Returns the data needed to display configured insights for today. The JSON response contains the following:

license: {…} A license object that contains the license state and the number of trial days left.

coworkers: […] A list of all available coworkers.

groups: […] A list of all available groups.

insights: […] A list of InsightViewModel trees available from the end of the current month and one year back.

Admin API

For these URIs the HTTP request must have a valid admin credentials cookie.

GET /admin/context Returns the context needed to display the Insight tab in the admin interface. The JSON response contains the following:

historyInsightModels: […] A list of saved history insight configuration models.

valueInsightModels: […] A list of saved value insight configuration models.

GET /admin/insight/context Returns the context needed to edit or create an insight configuration model. The JSON response contains the following:

groups: […] A list of all available groups.

coworkers: […] A list of all available coworkers.

activities: […] A list of all available activities.

valueFields: […] A list of all available value fields.

coworkerFields: […] A list of all available coworker fields.

dateFields: […] A list of all available date fields.

filters: […] A list of all available filters.

GET /admin/datasource/context

savedDataSources: […] A list of saved data sources.

detectedDataSources: […] A list of detected data sources.

GET /admin/settings/context Returns the context needed for editing the LIME Insight Settings.

licenseState: {string} The state of the license can be “TrialMode” “Verified” or “Expired”

trialDaysLeft: {number} The number of days left for the trial mode to expire.

serverAddress: {string} The saved server address.

suggestedServerAddress: {string} The suggested server address, normally the computer name.

matchInterval: {number} The saved match interval in minutes.

GET /admin/groups/context Returns the context needed to display, edit and create groups. The JSON response contains the following:

groups: […] A list of all available groups.

coworkers: […] A list of all available coworkers.

POST /admin/datasource Save a data source

DELETE /admin/datasource Delete a saved data source

PUT/admin/historyInsight Create or modify a history insight

DELETE /admin/historyInsight Delete a history insight

PUT/admin/valueInsight Create or modify a value insight

DELETE /admin/valueInsight Delete a value insight

PUT /admin/group Create or modify a group

DELETE /admin/group Delete a group

POST admin/license/{key} Register license key

POST admin/address/{address} Save the server address

POST /admin/matchinterval/{interval} Sets the interval between matchings.

GET /admin/log Returns the LIME Insight log as HTML.

GET /admin/log/insight-logs.zip Get zip package with files for troubleshooting. This log files and static content.