Add EMI APIs to Custom Widgets

There are three EMI APIs created for custom widgets: Get Bot Details, List Bots, and Get Bot Results.

• Get Bot Details — This API returns the bot parameters in JSON format. For example, bot name, types of analyses it runs, and its scheduling. When adding the snippet, insert the bot ID in the code so the query knows which bot information to pull. The bot ID can be found in the bot URL. Select the desired bot, then copy the ID from the URL.

  

• List Bots — This API returns a list of available bots and their general details in the current workspace in JSON format. For example, bot name, KPI, date, and the types of analyses it runs.

  Here is an example of JS code you can copy and paste to utilize the List Bots API:

  

  Note Be sure to change the bot id to the bot id you want to retrieve data for. This code snippet returns raw data. You can customize the code to create a visual display of your choice.

  DA.api.EMI.getBotsSummary({cb: (err, data) => { 
    var toPrint = "";
    data.bots.forEach((item, i) => {
      toPrint+= JSON.stringify(data.bots[i]) + "<br><br>"
    })
    
    document.getElementById("demo").innerHTML = toPrint;
  }});
  

• Get Bot Results — This API extracts the actual insights from a specific bot in JSON format. It includes data for each insight, such as the dimension and value of the insight, its performance, and its volume. Insert the bot ID that you want to populate. The bot ID appears in the URL.

  Here is an example of JS code you can copy and paste to utilize the Get Bot Results API:

  

  Note Be sure to change the bot id to the bot id you want to retrieve data for. This code snippet returns raw data. You can customize the code to create a visual display of your choice.

  DA.api.EMI.getInsightsByBotId({botId: 55149, cb: (err, data) => {
    var toPrint = "";
    data.insights.forEach((item, i) => {
      toPrint+= JSON.stringify(data.insights[i]) + "<br><br>"
    })
    
    document.getElementById("demo").innerHTML = toPrint;
  }});
  

If you want to populate several bots, dedicate each API call to a single bot by inserting the desired ID into each API.

Here’s a video about custom widgets: