API Reference

Grouping API Overview

Resources for grouping analyzed risk data

Terms

  • component analysis

Overview

The Grouping API collects API operations that support the creation and management of analysis groups.

An analysis group is an analysis that combines multiple analyses. An analysis group may include analysis results generated using ALM, DLM, and HD models as well as other analysis groups. By combining event loss data from multiple analyses, you can view an unified loss result for exposures across diverse perils and regions.

The analysis group is processed together and returns EP metrics that take all portfolio exposures into account when calculating the probability that financial losses from catastrophe events will exceed certain thresholds.

Entitlements

Client must be assigned one of the following entitlements to use this API:

  • RI-RISKMODELER
  • RI-UNDERWRITEIQ

Operations

The Grouping API exposes the following operations:

OperationMethodPathDescription
Search Grouping JobsGET/grouping/v1/jobsReturns list of GROUPING jobs.
Get Grouping JobGET/grouping/v1/jobs/jobIdReturns specific GROUPING job.
Create Grouping JobPOST/grouping/v1/jobsInitiates GROUPING job.
Update Grouping JobPATCH/grouping/v1/jobs/jobIdUpdates GROUPING job.