getInsightByID(insightID)
Retrieves the metadata of a specific insight.
Returns
A Promise that resolves to a response containing the metadata for the specified insight.
Parameters
Name | Type | Description | Required |
insightID | string | The 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"
// }]
// }]
// }
Previous topic getFieldsForDataSource(dataViewName, skipStoreCheck) Next topic getInsightIDs()