Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

getInsightByID(insightID)

Updated on July 20, 2021

Retrieves the metadata of a specific insight.

Returns

A Promise that resolves to a response containing the metadata for the specified insight.

Parameters

NameTypeDescriptionRequired
insightIDstringThe unique ID of the insight whose metadata is being retrieved.

Usage example

In this example, the API returns a Promise that resolves to a response containing the metadata for the specified insight.

const insightID = "124e9385-a623-4c55-ba8e-5af8cbd0ae64";
PCore.getAnalyticsUtils().getInsightByID(insightID).then(response => { console.log(response.data); }).catch(() => { ... });
// console output: {
//   pyInsights: [{
//     pyContent: "[stringified insight metadata json]",
//     pyName: "Insight Name",
//     pyPermissions: [{
//       pyAccessCategory: "Rule-Access-Role-Name",
//       pyAccessType: "view",
//       pyAccessValue: "TestApp:Users"
//     }]
//   }]
// }

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us