Analytics Endpoint

The details provided in the response to the analytics request are intended to provide detailed information for each scenario modeled, included income sources, expenses, account value, inflation, returns, and supportability ratios. These data are available upon request as full provision with the initial response would be expensive. The endpoint will take the following form:

• https://test.riseapi.net/frmws/ism/v1/analytics/{id}-{strategy}-{scenario} (development)
• https://www.riseapi.net/frmws/ism/v1/analytics/{id}-{strategy}-{scenario} (production)

In general, these analytics are designed for graphical representation as visualization helps with understanding. The data returned by the web service will remain as a json document. However, it may be useful to consider how one might chart the results. In demonstrations, Milliman FRM has leveraged both DevExpress and the Kendo UI library by Telerik. An example of the latter, using javascript, to graph the risk profile returned by the RISE web service is as follows:

function renderRiskChart() {
    $("#chart").kendoChart({
        title: {
            text: "Risk Composition"
        },
        legend: {
            position: "bottom"
        },
        seriesDefaults: {
            labels: {
                visible: true,
                background: "transparent",
                template: "#= category #: \n #= value#%"
            }
        },
        series: [{
            type: "pie",
            overlay: {
                gradient: "none"
            },
            data: [{
                category: "Inflation Risk",
                value: inflationRisk // From the Web service response
            }, {
                category: "Longevity Risk",
                value: longevityRisk // From the Web service response
            }, {
                category: "Market & Sequence of Returns Risk",
                value: returnsRisk // From the Web service response
            }]
        }],
    });
} 

Get

The URL path asks for a profile id, one of three strategies (also in the form of an id), and the scenario in question (1-1000).

• https://test.riseapi.net/frmws/ism/v1/analytics/{id}-{strategy}-{scenario} (development)
• https://www.riseapi.net/frmws/ism/v1/analytics/{id}-{strategy}-{scenario} (production)

Response

The income security module web service also provides an endpoint for retrieving analytics by scenario via HTTP GET. The details provided here tie to the profile, strategy, and scenario identifiers included in GET requests.