Get Insight Details
Use this REST API to retrieve the detailed representation of an existing Planning Insight identified by its external UUID (Universally Unique Identifier).
The response includes Insight metadata, status, Analyzer data-slice details, and a canonical self link. Set loadActuals=true to include historical actual values when supported by the Insight type.
Required Roles
Any authorized application role can retrieve existing insights. Generating or recomputing insights requires the Administrator or IPM Manage role.
REST Resource
GET
/HyperionPlanning/rest/v3/applications/{application}/insights/{insightId}
Request
Supported Media Types: application/json
Table 3-547 Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application |
Name of the application. The Insight is resolved only within this application. | Path | Yes | None |
insightId |
External UUID of the Insight. Obtain this identifier from the Planning REST v3 objects API by listing objects with objectType=Insights. Internal numeric Insight IDs are not accepted. | Path | Yes | None |
loadActuals |
Whether to include historical actual values. Values are included only when true and supported by the selected Insight type. | Query | No | False |
Example URL
Note:
- Replace the example UUID with an external Insight UUID obtained from the objects API. Omit loadActuals or set it to false to retrieve details without requesting historical actual values.
- The external UUID is a deterministic representation of the internal Planning Insight identifier. The UUID is validated before lookup. Internal numeric Insight IDs are never returned by this endpoint.
GET https://<BASE-URL>/HyperionPlanning/rest/v3/applications/<APPLICATION>/insights/1a2b3c4d-5e6f-8a9b-9d34-7a6cf87e2a34?loadActuals=trueResponse
The following table summarizes the response parameters.
Table 3-548 Parameters
| Name | Description |
|---|---|
id |
External UUID of the Insight. |
objectType |
Object type. The value is Insights. |
name |
Localized Insight title. |
insightDesc |
Localized Insight description. |
insightType |
Type of Insight. |
cubeName |
Cube or plan type name. |
dataSlice |
Analyzer data-slice details, including gridDefinition and export/format options. |
dataSlice.gridDefinition |
Analyzer grid definition, including POV, row and column segments, suppression options, and prediction calendar. |
links |
Resource links. The self link uses GET and identifies the canonical URL for the Insight. |
Note:
Within each POV, row, or column segment, the arrays in members, exclude, and excludeAll
align by index with dimensions. When loadActuals=true, historical actual
values are included only when supported by the selected Insight type.
Supported Media Types: application/json
Parameters
Example of Response Body
The following shows an example of the response body in JSON format.
{
"id": "1a2b3c4d-5e6f-8a9b-9d34-7a6cf87e2a34",
"objectType": "Insights",
"name": "<localized insight title>",
"insightDesc": "<localized insight description>",
"insightType": "<insight type>",
"insightStatus": "<insight status>",
"cubeName": "Plan1",
"dataSlice": {
"exportPlanningData": false,
"formatPercentageAsPercent": true,
"gridDefinition": {
"pov": {
"dimensions": [
"Scenario",
"Version",
"Years"
],
"members": [
[
"Actual"
],
[
"Working"
],
[
"FY26"
]
],
"exclude": [
[],
[],
[]
],
"excludeAll": [
[],
[],
[]
]
},
"rows": [
{
"dimensions": [
"Entity",
"Account"
],
"members": [
[
"<entity member>"
],
[
"<account member>"
]
],
"exclude": [
[],
[]
],
"excludeAll": [
[],
[]
]
}
],
"columns": [
{
"dimensions": [
"Period"
],
"members": [
[
"Jan",
"Feb",
"Mar"
]
],
"exclude": [
[]
],
"excludeAll": [
[]
]
}
],
"suppressMissingBlocks": false,
"suppressMissingRows": false,
"suppressMissingColumns": false,
"predictionCalendarName": "<calendar name>"
}
},
"links": [
{
"rel": "self",
"action": "GET",
"href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/<APPLICATION>/insights/1a2b3c4d-5e6f-8a9b-9d34-7a6cf87e2a34"
}
]
}
Table 3-549 Status Codes
| Code | Description |
|---|---|
400 Bad Request |
The Insight identifier is missing, is not a UUID, or is not a valid external Insight UUID. |
401 Unauthorized |
The request has no valid authenticated Planning session. |
404 Not Found |
The application does not exist, the Insight does not exist in that application, or the caller lacks access to it. Access denial returns 404 to avoid revealing whether an Insight exists. |
500 Internal Server Error |
An unexpected server error occurs while retrieving Insight details. |