Moody’s strongly recommends that Risk Modeler and UnderwriteIQ tenants use the Platform APIs instead of the Risk Modeler APIs for all future projects. See Migrate to Plaform APIs.

API Reference

Get metrics

get
https://{host}/riskmodeler/v2/analyses//metrics

Returns metrics for the specified analysis result.

Path Params
int32
required
≥ 1

ID number of result.

Query Params
string
enum
required

Type of metrics returned. Valid options depend on value of the granularity parameter.

  • If ACCOUNT, one of MARGINAL_EP or MARGINAL_STATS.
  • If POLICY, one of ELT, EP, MARGINAL_EP, MARGINAL_STATS orSTATS.
Allowed:
position
array of strings
required

Array of financial perspectives.

position*
granularity
array of strings

The granularity of the metrics retrieved. One of ACCOUNT or POLICY.

granularity
epType
array of strings

The exceedence probability method to calculate losses. One of OEP, AEP, TCE_AEP, TCE_OEP.

epType
returnPeriod
array of int32s
length between 0 and 13

returnPeriod.

returnPeriod
string

Filter condition.

string

Comma-delimited property name followed by ASC (to display the results in alphabetical or numerical ascending order) or DESC (to display the results in descending order.)

int32
≤ 1000
Defaults to 100

Number of records returned. By default, 100.

int32
Defaults to 0

Number of pages offset before the first page of returned records. By default, 0.

Responses

Updated over 2 years ago

Language
Credentials
URL
Response 
 Choose an example:
application/json
Updated over 2 years ago