Get a scorecard for an alert

get/alerts/{alertId}/scorecard

Returns a scorecard for the given alert.

Request Samples

1

Response Samples

1{
2 "version": 1,
3 "score": 600,
4 "scoreRangeHigh": 900,
5 "scoreRangeLow": 600,
6 "entityScenarios": [
7 {
8 "version": 1,
9 "entityId": "PA126272053",
10 "entityLabel": "PA126272053",
11 "entityType": "tdc_policy",
12 "scenarios": [
13 {
14 "creationTimeStamp": "2024-05-01T08:22:56.454Z",
15 "modifiedTimeStamp": "2024-05-01T08:22:56.454Z",
16 "createdBy": "sas.svi-alert",
17 "modifiedBy": "sas.svi-alert",
18 "links": [
19 {
20 "method": "GET",
21 "rel": "self",
22 "href": "/svi-alert/scenarioFiredEvents/ABDDF7B1-F096-DB44-8692-7B210B14F2C3",
23 "uri": "/svi-alert/scenarioFiredEvents/ABDDF7B1-F096-DB44-8692-7B210B14F2C3",
24 "type": "application/vnd.sas.investigation.triage.scenario.fired.event.extended"
25 },
26 {
27 "method": "GET",
28 "rel": "context",
29 "href": "/svi-alert/scenarioFiredEvents/ABDDF7B1-F096-DB44-8692-7B210B14F2C3/replicatedObjects",
30 "uri": "/svi-alert/scenarioFiredEvents/ABDDF7B1-F096-DB44-8692-7B210B14F2C3/replicatedObjects",
31 "type": "application/json",
32 "responseType": "application/vnd.sas.collection",
33 "responseItemType": "application/vnd.sas.investigation.data.document"
34 }
35 ],
36 "version": 1,
37 "scenarioFiredEventId": "ABDDF7B1-F096-DB44-8692-7B210B14F2C3",
38 "scenarioFiredEntityType": "tdc_policy",
39 "scenarioFiredEntityId": "PA126272053",
40 "scenarioId": "049f02de-ef4a-497e-a9a3-61a80a8098f5",
41 "scenarioName": "Too Many Claims From Same IP Address",
42 "scenarioOriginCode": "SA",
43 "ruleId": "73b1a1d7-3307-4582-ad8d-8c9e67748c2f",
44 "deploymentId": "b4578588-60a7-465e-b47f-a138379b960d",
45 "score": 600,
46 "displayFlag": true,
47 "displayOrder": 1,
48 "displayTypeCode": "TEXT",
49 "messageTemplateText": "",
50 "messageValuesJson": {
51 "aggregation1": "4"
52 },
53 "messageValuesJsonAsText": "{\"aggregation1\":\"4\"}",
54 "recommendedQueueId": "insurance_investigations",
55 "contextRelationshipName": "tdc_claim",
56 "contextTimeStampFieldName": "report_date",
57 "contextStartTimeStamp": "2017-01-01T00:00:00.000Z",
58 "contextEndTimeStamp": "2017-10-24T23:59:59.999Z",
59 "replicateFlag": true,
60 "replicationPolicy": "INTERNAL",
61 "contributingObjects": [
62 {
63 "creationTimeStamp": "2024-05-01T08:22:56.646Z",
64 "modifiedTimeStamp": "2024-05-01T08:22:56.646Z",
65 "createdBy": "sas.svi-alert",
66 "modifiedBy": "sas.svi-alert",
67 "version": 1,
68 "contributingObjectType": "tdc_claim",
69 "contributingObjectId": "ACNV9954899792",
70 "workspaceFlag": false,
71 "triggeringFlag": true,
72 "alertingEventId": "4764dc72-7e08-4482-8360-4ea05c3f81b7",
73 "scenarioFiredEventId": "ABDDF7B1-F096-DB44-8692-7B210B14F2C3"
74 }
75 ]
76 }
77 ]
78 }
79 ]
80}

Path Parameters

NameTypeRequiredDescription
alertId
string
true

Specifies the identifier of the alert.

<= 36 characters

Query Parameters

NameTypeRequiredDescription
includeScenarioFiredEventLabels
boolean
false

Specifies whether to include scenario fired event labels in the response. This has a small performance overhead.

Default:
false

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request

The request was invalid.

Schema
404Not Found

No alert exists at the requested path.

Schema
500Internal Server Error

The request could not be fulfilled because of an unexpected server error.

Schema