API Reference

Get metrics

get
https://{host}/riskmodeler/v2/analyses//metrics
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
Allowed:
epType
array of strings

The exceedence probability method to calculate losses. One of OEP, AEP, TCE_AEP, TCE_OEP, SMOOTHED_AEP, SMOOTHED_OEP. SMOOTHED_AEP and SMOOTHED_OEP are returned only when the marginal impact analysis was run with smoothed results enabled.

epType
Allowed:
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 13 days ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 13 days ago

Did this page help you?