Skip to main content
POST
Create Risk Segmentation Config

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
analysisId
string
required

The analysis run id this config belongs to. Required on create.

name
string
required

Display name of the config. Must be unique within the analysis.

Maximum string length: 80
segments
string[]
required

Ordered hierarchy of grouping fields for the dashboard table. Must include risk_score. See the tag description for built-in keys and custom analysis rules.

Minimum array length: 1
columns
string[]
required

Ordered list of summary metrics shown for each segment row (for example total_count, total_value, risk_avg). See the tag description for allowed values.

Minimum array length: 1
displayCellVisuals
boolean

When true, shows in-cell sparkline visuals for numeric columns. Defaults to false.

enabled
boolean

When false, the config is stored but not selected by default in the dashboard. Defaults to true.

riskScoreIds
string[]

Optional risk score ids (ensemble ids) to limit which scores are in scope. Empty or omitted means all enabled scores.

riskGroups
string[]

Optional risk group category names to limit which assertion categories are in scope (for example GENERAL, PROFIT_LOSS). Empty or omitted means all groups.

Response

201 - application/json

Created

id
string

The unique object identifier.

version
integer<int64>

Data integrity version to ensure data consistency.

creationDate
string<date-time>
lastModifiedDate
string<date-time>
createdUserInfo
User Info · object
read-only
lastModifiedUserInfo
User Info · object
read-only
analysisId
string

The analysis run id this config belongs to. Required on create.

analysisTypeId
string

The analysis type id for this config. Set from the analysis on create; returned on read.

name
string

Display name of the config. Must be unique within the analysis.

segments
string[]

Ordered hierarchy of grouping fields for the dashboard table. Must include risk_score. See the tag description for built-in keys and custom analysis rules.

columns
string[]

Ordered list of summary metrics shown for each segment row (for example total_count, total_value, risk_avg). See the tag description for allowed values.

displayCellVisuals
boolean

When true, shows in-cell sparkline visuals for numeric columns. Defaults to false.

enabled
boolean

When false, the config is stored but not selected by default in the dashboard. Defaults to true.

riskScoreIds
string[]

Optional risk score ids (ensemble ids) to limit which scores are in scope. Empty or omitted means all enabled scores.

riskGroups
string[]

Optional risk group category names to limit which assertion categories are in scope (for example GENERAL, PROFIT_LOSS). Empty or omitted means all groups.