API Quick Overview

Integration with Emcien REST APIs

Discovering patterns within historical data and making predictions about future data has limited value if you can’t easily integrate the predicted actions and remedies back into your existing processes and systems.  Emcien RESTful APIs provide a very fast and simple way to connect the results of any analysis and even make real-time predictions using standard REST calls.  This provides for very powerful operational solutions for that can drive:

  • Interactive Dashboards

  • Workflow and Resource Management systems

  • Supply Chain systems

  • Contact Center systems

Easy Access to Results

All of the API endpoints follow standard REST patterns involving either HTTP GET, POST or DELETE.  Below are examples of how easy it is to leverage these APIs for real life problems.

For example, to return the predictive rules automatically discovered for a sample “Customer Churn” dataset,  we could simply call the predictive “rules” endpoint like this for a specific analysis (e.g. “57901500”):

The results are returned in standard JSON format with all of the information you would need to drive dashboards, workflow systems, etc.

In addition to the data you would see in the EmcienPatterns UI, additional detailed metrics are provided allowing for an even greater understanding of what was discovered by the EmcienPatterns Engine.

The API provides the ability to easily search and filter results by data elements, categories & features as well as sort on key fields making real-time interactions and communications a snap.

Paging of the response data ensures you get what you want in a timely manner and still control how much you consume per call to the api.

Real-Time Predictions

In addition to retrieving auto-discovered patterns and metrics, EmcienPatterns REST API provides the ability to make real-time predictions on-the-fly.  

Here is an example of how easy it is to make a prediction about a customer where we only know a minimum of one thing and we want Patterns to use it’s learned rules to make a prediction and provide reasons/remedies for that prediction:

Make an HTTP POST call to our ‘real_time_predictions’ endpoint:

And providing even just a single piece of information about a customer contract (“Two-year Contract”) as our parameters along with id of our rules discovered from the Churn data:

We get back a full prediction for all possible outcomes along with reasons for why made the prediction.  These reasons are rules from the learned data set so they are actionable by any downstream system or person.

A Complete Set of Endpoints

EmcienPatterns offers all of the endpoints you need to cover every step of the analysis process including:

  • Data Prep (using Emcien Bandit)

  • Data Analysis (i.e. extracting the predictive rules)

  • Predictions (Real-time or Batch)

The full set of EmcienPatterns endpoints include:

  1. Bandit - binning and data prep

  2. Categories - features or groupings of data elements defined externally

  3. Clusters - groupings of elements discovered by the software that occur together

  4. Items - all of the unique items discovered in the analyzed data

  5. Outcomes - metadata and facts discovered about the items in the dependent category

  6. Predictions - predictions about individual transactions with “reasons why”

  7. Projects - higher level groupings of individual analyses

  8. Reports - pattern analysis of data to discover other attributes about data other than rules

  9. Rules - conditional probability rules discovered about the data analyzed

For more details on how to use the API endpoints see the article on 'Using the Emcien RESTful API'.

For more information about the APIs and their usage feel free to contact services@emcien.com.