Get EP statistics

get

https://{host}/platform/riskdata/v1/analyses/{analysisId}/stats

Returns a list of statistics for the specified EP analysis.

An exceedance probabilistic (EP) analysis is a full probabilistic analysis of an exposure that returns OEP and AEP curves, which represent cumulative distributions that show the probability that losses will exceed a certain amount, from either single or multiple occurrences.

Request parameters vary depending on the analysis type. For ALM- and DLM-based analysis results, the exposureResourceType parameter is required and the exposureResourceId parameter supports metrics grouped at other exposure resource levels. For HD- and HD-ALM based analysis results, this operation returns analysis-level results only; the exposureResourceType parameter is ignored and the exposureResourceId must match that of the specified analysis.

Path Params

analysisId

int64

required

≥ 1

ID of analysis result.

Query Params

perspectiveCode

array of strings

required

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

perspectiveCode*

exposureResourceId

int32

≥ 0

ID of exposure resource (e.g. account,location, portfolio).

exposureResourceType

string

enum

required

Type of exposure resource.

Required if the specified analysisId is DLM analysis. If HD analysis, exposure resource type of analysisId is used.

filter

string

Query string to select response data based on property values. See Filtering Responses.

If exposureResourceType is POLICY, supports filtering by exposureResourceId using the = or IN operators .
If exposureResourceType is any other exposure type, filtering is not supported.

See Filtering Responses.

sort

string

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

If exposureResourceType is POLICY, supports sorting by activation, cv, exhaustion, exposureResourceId, exposureResourceNumber, limit, netPurePremium, perspectiveCode, premium, purePremium, totalLossRatio, totalStdDev.
If exposureResoruceType is any other exposure type, sorting is not supported.

limit

int32

≤ 1000

Number of records returned per page. See Response Pagination

offset

int32

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

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200Success

400Bad Request

401Unauthorized

403Forbidden

404The requested resource was not found.

500Internal Server Error