Salesforce Docs Portal

Get Descriptive and Diagnostic Insights Programmatically

Use Einstein Discovery's Insights API to embed insights from your model into any website, application, or dashboard. Insights contain values that quantify the impact on the selected model goal, along with narrative descriptions of those values. With the Insights API, client applications can obtain a summary of the top positive and negative insights, query insight details further, and then apply their own narratives to the insight values. You can also query insights by insight type (descriptive or diagnostic).

Required Editions

Note
Note Einstein Discovery stories are now models. We wish we could snap our fingers to update the name everywhere, but you can expect to see the previous name in a few places until we replace it.
User Permissions Needed
To run REST API commands on the Insights API: Use Einstein Discovery

The Insights API provides REST API endpoints that enable you to:

  • query descriptive and diagnostic insights
  • get insight summaries
  • get metadata for models and model versions

Each resource (models, model versions, and insights) has a unique id. These REST endpoints allow you read-only access.

To interact with the Insights API, use your favorite REST client. You must have a external client app that handles Salesforce authentication for your REST client. To learn more, take the External Client App Basics Trailhead module.

See Also