Inights Summary

Use this REST API to generate a narrative or statistical summary for one or more insights, or for a member slice when insights are not already available.

The API can summarize selected insights by ID or generate a summary for a slice of Planning cube data. It supports text, HTML, or JSON output and can apply an optional summary hint to guide summary generation.

Required Roles

Any authorized Planning application role with access to the referenced application, cube, slice, and insights.

REST Resource

POST /HyperionPlanning/rest/v3/applications/{application}/insights/summary

Request

Supported Media Types: application/json

Table 3-71 Parameters

Name	Description	Type	Required	Default
ids	Insight IDs to summarize. If both ids and slice are provided, ids take precedence.	array[string]	No	None
dataSourceType	CUBE for Planning cube data.	enum	No	None
slice	Defines the POV, row axis, and column axis for summary generation.	object	Required unless ids are provided	None
location	For CUBE, cube or plan type name such as Plan1.	string	Conditional	None
retrievalMode	USE_EXISTING or FORCE_RECOMPUTE.	enum	Yes unless ids are provided	None
calendar	Calendar used to derive period and year information.	string	Required if slice is provided and retrievalMode is FORCE_RECOMPUTE	None
size	Maximum summary length in words	integer	No	100
format	text, html, or json.	enum	No	text
summaryHint	Optional template or guidance for summary generation.	string	No	None
queryParams	Optional filters such as TOP and TYPE to narrow the insight set.	object	No	None

Example of Request Body

{
  "slice": {
    "pov": {
      "members": [
        "7003",
        "OAD",
        "P_000",
        "BaseData"
      ],
      "dimensions": [
        "Account",
        "Entity",
        "Product",
        "HSP_View"
      ]
    },
    "columnAxisDefinition": {
      "dimensions": [
        "Year",
        "Period"
      ],
      "segments": [
        [
          [
            "FY25"
          ],
          [
            "Jul",
            "Aug",
            "Sep",
            "Oct",
            "Nov",
            "Dec"
          ]
        ],
        [
          [
            "FY26"
          ],
          [
            "Jan",
            "Feb",
            "Mar",
            "Apr",
            "May",
            "Jun"
          ]
        ]
      ]
    },
    "rowAxisDefinition": {
      "dimensions": [
        "Version",
        "Scenario"
      ],
      "segments": [
        [
          [
            "Working"
          ],
          [
            "Forecast"
          ]
        ],
        [
          [
            "Most Likely"
          ],
          [
            "Predictive Forecast"
          ]
        ]
      ]
    }
  },
  "dataSourceType": "CUBE",
  "location": "Plan1",
  "retrievalMode": "USE_EXISTING",
  "size": 100,
  "format": "text"
}

Response

The following table summarizes the response parameters.

Table 3-72 Parameters

Name	Description
summary	Narrative or statistical summary. Returns a string when format is text or html, and a JSON object when format is json.
href	Link to API call.
action	HTTP call type.
resolvedNarrative	Optional resolved template strings when summaryHint is provided.
warnings	Optional warnings, for example unsupported hint placeholders or fallback to statistical summary.

Supported Media Types: application/json

Parameters

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "links": [
    {
      "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/<APPLICATION>/insights/summary",
      "action": "POST",
      "rel": "self"
    }
   ],
  "summary": "From January FY22 to December FY23, actual product revenue totaled $5.56 million, below forecast. Forecasts exceeded actuals in most periods, indicating a persistent over-forecasting pattern. September FY23 deviated from the historical monthly average and should be reviewed."
}