Get marginal EP metrics

get

https://{host}/platform/riskdata/v1/analyses/{analysisId}/marginal-ep

Returns EP metrics for the specified DLM analysis.

Exceedance probability (EP) analysis takes the full range of possible events and losses into consideration during analysis. These losses are expressed as occurrence exceedance probability curves (OEP curves) and aggregate exceedance probability curves (AEP curves).

Path Params

analysisId

int64

required

≥ 1

ID of analysis.

Query Params

perspectiveCode

array of strings

required

Financial perspective that determines how losses are calculated. See Financial Perspectives

perspectiveCode*

granularity

array of strings

required

Level of detail of metrics returned. One of ACCOUNT or POLICY

granularity*

filter

string

Query string to select response data based on property values.

Supports filtering by epType or returnPeriod using the = and IN operators.

See Filtering Responses.

sort

string

Comma-delimited list of properties. Response is sorted by each property. Sort order defined by one ofASC or DESC.

Supported properties: ep, epType, policyId, policyNumber, position, positionValue. See Response Pagination.

limit

int32

≤ 1000

Defaults to 100

Number of records returned per page. See Response Pagination. maximum is 1000

offset

int32

Defaults to 0

Number of the page displaying the returned records, starting at 0

Responses

200Success

400Bad Request

401Unauthorized

403Forbidden

404The requested resource was not found.

500Internal Server Error