Filter Results and Metrics

Use query string parameters to view analysis results data.

Overview

Metrics API operations support the filtering of analysis result data by means of query string parameters that specify analysis result attributes values.

The API reference documenation page list the query parameters that are supported by each operation. For example, the Get Metrics operation supports the metricType, position, granularity, epType, returnPeriod, filterCondition, sort, limit, and offset query parameters.

Some operations support the sort, limit, and offset query parameters. For detailed information, on using these query parameters, see Query Parameters.

Using analysis results query parameters in tandem with the sort query parameter makes it easy for you to compare the metrics returned so that you may identify exposures at the greatest risk.

EP curve type filters

The epType query parameter enables you to filter metrics by EP curve types. Options include AEP, OEP, TCE_AEP, and TCE_OEP.

An EP curve is a cumulative distributions showing the probability that losses will exceed a certain amount, from either single or multiple occurrences. Losses are expressed in the occurrence exceedance probability (OEP) and the aggregate exceedance probability (AEP) curves.

For example, the Get Metrics operation supports filtering by EP type:

curl --request GET \
     --url 'https://{host}/riskmodeler/v2/analyses/analysisID/metrics?granularity=POLICY& \
         epType=AEP& \
         epType=TCE_AEP& \
         limit=100& \
         offset=0' \
     --header 'Authorization: XXXXXXXXXX' \
     --header 'accept: application/json'

Risk Modeler API supports the following EP curve type query parameters as filters:

CodeDescription
AEPProbability that the total losses across all events in a year will meet or exceed a loss threshold.
OEPProbability that at least one event will occur in a year that causes losses greater than or equal to a certain amount.
TCE_AEP TCE is the expected value of loss given that a loss at least as large as RPLα has occurred based on AEP losses. Conditional expectation of losses that are greater than or equal to a specified loss threshold RPLα, where α is the selected risk tolerance threshold and RPLα is the corresponding is the return period loss.
TCE_OEPTCE is the expected value of loss given that a loss at least as large as RPLα has occurred based on AEP losses. Conditional expectation of losses that are greater than or equal to a specified loss threshold RPLα, where α is the selected risk tolerance threshold and RPLα is the corresponding return period loss.

Event ID filters

The eventIds query parameter enables you to filter result metrics by event IDs.

An event is a representation of a peril (e.g. earthquake, flood, hurricane) with the potential to generate catastrophe losses. For a given peril, all potential events are synthesized into a stochastic event set, which defines the occurrence and magnitude of each event. Events within an event set are identified by a unique event ID.

The Get ELT and Get Sampled Losses operations supports filtering by Event IDs.

curl --request GET \
     --url 'https://{host}/riskmodeler/v2/analyses/id/elt?perspective=RN& \
         treatyId=56& \
         eventIds=6789& \
         eventIds=6790& \
         eventIds=6791 \
     --header 'Authorization: XXXXXXXXXX' \
     --header 'accept: application/json'

Exposure ID filters

The exposureId query parameter enables you to filter metrics by exposure ID.

An exposure is an entity that may produce a financial loss when impacted by an event. Exposures are identified by their exposure type and a unique ID number.

The exposure ID identifies the exposure (e.g. location, account, portfolio) analyzed.

The Get ELT, Get EP Metrics, Get EP Interpolation, Get Key Losses, Get PLT, Get Sampled Losses, and Get Statistics operations support filtering by exposure IDs.

curl --request GET \
     --url 'https://{host}/riskmodeler/v2/analyses/id/elt?exposureId=45' \
     --header 'Authorization: XXXXXXXXXX' \
     --header 'accept: application/json'

Exposure type filters

The exposureType query parameter enables the client to filter perspectives by exposure type. If unspecified, the service uses the default value of 0 and returns all exposure types.

Each exposure type is identified by a four-digit numberic code, e.g. 8017 (Portfolio or Group), 8019 (Account), 8020 (Location).

The Get ELT, Get EP Metrics, Get EP Interpolation, Get Key Losses, Get Financial Perspectives, Get PLT, Get Sampled Losses, and Get Statistics operations support filtering by exposure IDs.

curl --request GET \
     --url 'https://{env_url}/riskmodeler/v2/analyses/35/keylosses?exposureType=8020' 

The exposureType query parameter may be defined by the following values:

IDDescription
0Default. Returns perspectives for all exposure types
7937 Treaty
7938 PortByCedant
7939 AccountCoverage
7940EQLocationCvgDetail
7941HULocationCvgDetail
7942TOLocationCvgDetail
7943 PortByRegion
7950PortByPostCode
7951 PortByPostCodeLOB
7951portbypostcodelob
7952portbyloccode
7953portbyloccodelob
7954portbydistrict
7955portbydistrictlob
7956portbycity
7957portbycitylob
7958portbycounty
7959portbycountylob
7960portbycresta
7961portbycrestalob
7962portbystate
7963portbystatelob
7964portbylob
7965portinjurylevel
7966acctinjurylevel
7967policyinjurylevel
7968locationinjurylevel
7969locpeoplegroupinjurylevel
7970policyspecialconditions
7971buildingcoverage
7972buildinginjurylevel
7975portbycountry
7976portbycountrybylob
7981portbycountybycedant
7982portbycrestabycedant
7983portbystatebycedant
7984portbycountrybycedant
7986portbypostcodebylobbycedant
7990portbycountylobbycedant
7991portbycrestalobbycedant
7992portbystatelobbycedant
7993portbycountrybylobbycedant
8017portfolio
8019account
8020location
8021policy
8022locationcoverage
8023policycoverage
8024reinsurancecession
8025eqlocationdetail
8026hulocationdetail
8027tolocationdetail
8028fllocationdetail
8029aggportfolio
8030portfoliocoverage
8031locationpeoplegroup
8035building
9000fac

Filter condition filters

The filterCondition query parameters enable you to filter metrics by job IDs.

The Get Metrics operation supports filtering by return periods and filter conditions.

curl --request GET \
     --url 'https://{host}/riskmodeler/v2/analyses/analysisID/metrics?returnPeriod=33&filterCondition=condition&limit=100&offset=0' \
     --header 'Authorization: XXXXXXXXXX' \
     --header 'accept: application/json'

Granulariy filters

The granularity query parameters enable you to filter metrics by output levels.

The Get Metrics operation supports filtering by the POLICY granularity.

curl --request GET \
     --url 'https://{host}/riskmodeler/v2/analyses/analysisID/metrics?granularity=POLICY& \
         epType=AEP& \
         epType=TCE_AEP& \
         limit=100& \
         offset=0' \
     --header 'Authorization: XXXXXXXXXX' \
     --header 'accept: application/json'

Job ID filters

The jobId query parameters enable you to filter metrics by job IDs.

The jobId parameter is supported by all Risk Modeler GET operations in the Metrics collection.

curl --request GET \
     --url 'https://{host}/riskmodeler/v1/analyses/analysisID/elt?perspective=GU& /
         jobUUID=a433baa3-8e1e-47ff-8098-f8781d9b3c32& /
         exposureId=8& /
         exposureType=8017& /
         jobId=134866' /
     --header 'Authorization: XXXXXXXXXX' \
     --header 'accept: application/json'

Job UUID filters

The jobuuid query parameters enable you to filter metrics by job UUIDs.

The jobUUID parameter is supported by all Risk Modeler GET operations in the Metrics collection.

curl --request GET \
     --url 'https://{host}/riskmodeler/v1/analyses/analysisID/elt?perspective=GU& /
         jobUUID=a433baa3-8e1e-47ff-8098-f8781d9b3c32& /
         exposureId=8& /
         exposureType=8017& /
         jobId=134866' /
     --header 'Authorization: XXXXXXXXXX' \
     --header 'accept: application/json'

Key and value filters

The key and value query parameters enable you to filter metrics by key-value attributes.

The Get EP Interpolation operation supports filtering by keys and key values.

curl --request GET \
     --url 'https://{host}/riskmodeler/v2/analyses/id/ep/interpolate?key=key& \
         value=value' \
     --header 'Authorization: XXXXXXXXXX' \
     --header 'accept: application/json'

Metric type filters

The metricType query parameter enables you to filter analysis result data based on the metrics.

The Get EP Metrics, Get EP Interpolation, and Get Metrics operation supports filtering by metric types. One of ELT, EP, or STATS.

curl --request GET \
     --url 'https://{host}/riskmodeler/v2/analyses/45/ep?metricType=ELT' 

Risk Modeler API supports the following metric type parameter values:

CodeDescription
ELTThe event loss table (ELT) is an output table that contains the mean loss standard deviation, exposure value, and event rate for every loss-causing event. In DLM models, the ELT is the basis of losses for all financial perspectives at all exposure levels. To learn more, see Event loss tables
EPEP metrics measure the probability that an event will occur in a year that causes losses greater than or equal to a certain amount. To learn more, see EP metrics
STATSStatistics include the average annual loss, standard deviation, and coefficient of variation. To learn more, see Statistics

Perspective filters

The perspective query parameter identifies the financial perspective. Financial perspectives are identified by a two-character string.

The Get Cedants by Result, Get ELT, Get EP Interpolation, Get Key Losses, Get Location AAL Metrics, Get Metrics, Get PLT, Get Sampled Losses, and Get Statistics operations support filtering by financial perspective.

curl --request GET \
     --url 'https://{env_url}//riskmodeler/v2/analyses/34/location-aal?perspective=GR \
            &sort=AAL%20DESC \
            &limit=100 \
            &offset=0' 

Risk Modeler supports the following perspective query parameters as filters:

CodeDescription
GUGround Up Loss
GSGround Up Specified Loss
G2Ground Up Loss - Secondary Peril
G1Ground Up Loss - Primary Peril
CLClient Loss
UCUnderlying Coverage
OLOver Limit Loss
OIOther Insurer’s Loss
GRGross Loss
FAFaculative Reinsurance Loss
SSSurplus Share Treaty Loss
QSQuota Share Treaty Loss
WXWorking Excess Treaty Loss
RLNew Loss Pre Cat
RPNet Loss Post Cat
RCNet Loss Post Corporate Cat
RGReinsurance Gross Loss
RNReinsurance New Loss

Financial perspectives are understood to be upstream or downstream of one another. The position of one perspective relative to one another perspective is an important factor in financial perspective mapping. For more information, see Map perspective by analysis.

Return period filters

The returnPeriod query parameter enables you to filter by return period.

A return period is a point on an EP curve that describes the likelihood of exceeding a loss threshold from the single largest event (OEP) or the aggregation of one or more events (AEP). The return period is defined as the inverse of the annual exceedance probability. For example, a return period of 100 years corresponds to an annual exceedance probability of 1%. In the context of peril events, return period refers to the number of years between occurrences of an event of a given size in the region. Short and long return periods enable modelers to estimate risk at both short and long-range exceedance probabilities.

The Get Metrics operation supports filtering by return periods. Must be a value between 2 and 49999.

curl --request GET \
     --url 'https://{host}/riskmodeler/v2/analyses/analysisID/metrics?returnPeriod=2500& \
         limit=100& \
         offset=0' \
     --header 'Authorization: XXXXXXXXXX' \
     --header 'accept: application/json'

Run date filters

The runDate query parameter enables you to filter analysis results by the date the analysis was processed.

The Get Results operation supports filtering by run date.

curl --request GET \
     --url 'https://{host}/riskmodeler/v2/[email protected]& \
         runDate=Apr-10-2020'

Treaty ID filters

The treatyId query parameter enables you to filter analysis results by treaty ID.

By viewing losses at the treaty-level, you can better assess capacity and coverage and make corresponding pricing decisions.

The Get EP Metrics, Get ELT, Get EP Interpolation, Get key Losses, Get PLT, Get Sampled Losses, and Get Statistics operations support treaty ID filtering.

curl --request GET \
     --url 'https://{host}/riskmodeler/v2/analyses/id/elt?perspective=RN& \
         treatyId=56& \
         eventIds=6789& \
         eventIds=6790& \
         eventIds=6791 \
     --header 'Authorization: XXXXXXXXXX' \
     --header 'accept: application/json'

User name filters

The userName query parameter enables you to filter analysis results by the name of the principal that submitted that analysis job.

A principal is an entity that identifies an authorized end user or client application. Intelligent Risk Platform supports two principals: user accounts for end users of applications and API keys for client applications. Principals gain access rights and permissions to protected resources by being members of a group that has been granted those access rights and permissions.

For example, the Get Results operation supports user name filtering.

curl --request GET \
     --url 'https://{host}/riskmodeler/v2/analyses?userName=p_name& \
         runDate=date-string'