Get alerts metrics

POST 
/stats/app/get-alerts-metrics

Get alerts metrics.

Request

application/json

Body

required

timeframe stringrequired

Possible values: [day, week, month, year, allTime]

cmsProjectId stringrequired
officerId string
category string

Possible values: [Onboarding, Ongoing monitoring]

customerType string

Possible values: [Individual, Company]

Responses

200

Successful response

application/json

Schema

Schema

totalCount objectrequired
current numberrequired
previous numberrequired
totalNewCount objectrequired
current numberrequired
previous numberrequired
totalOpenedCount objectrequired
current numberrequired
previous numberrequired
totalClosedCount objectrequired
current numberrequired
previous numberrequired
totalInProgressCount objectrequired
current numberrequired
previous numberrequired
totalUnassignedCount objectrequired
current numberrequired
previous numberrequired
totalOverdueCount objectrequired
totalMoreThan14Days numberrequired
totalMoreThan30Days numberrequired
ageOfOldestAlert date-timerequired
alertsPerOfficer object[]required
Array [
officerId stringnullablerequired
count numberrequired
]
totalEscalatedCount objectrequired
current numberrequired
previous numberrequired
ageOfOpenAlerts object[]required
Array [
placeholder stringrequired
count numberrequired
]
alertsByType object[]required
Array [
alertType stringrequired
count numberrequired
]
alertsAverageSeverity objectrequired
average numberrequired
counts object[]required
Array [
severity stringnullable
Possible values: [Low, Medium, High]
count numberrequired
]

Example (from schema)

{
  "totalCount": {
    "current": 0,
    "previous": 0
  },
  "totalNewCount": {
    "current": 0,
    "previous": 0
  },
  "totalOpenedCount": {
    "current": 0,
    "previous": 0
  },
  "totalClosedCount": {
    "current": 0,
    "previous": 0
  },
  "totalInProgressCount": {
    "current": 0,
    "previous": 0
  },
  "totalUnassignedCount": {
    "current": 0,
    "previous": 0
  },
  "totalOverdueCount": {
    "totalMoreThan14Days": 0,
    "totalMoreThan30Days": 0
  },
  "ageOfOldestAlert": "2024-07-29T15:51:28.071Z",
  "alertsPerOfficer": [
    {
      "officerId": "string",
      "count": 0
    }
  ],
  "totalEscalatedCount": {
    "current": 0,
    "previous": 0
  },
  "ageOfOpenAlerts": [
    {
      "placeholder": "string",
      "count": 0
    }
  ],
  "alertsByType": [
    {
      "alertType": "string",
      "count": 0
    }
  ],
  "alertsAverageSeverity": {
    "average": 0,
    "counts": [
      {
        "severity": "Low",
        "count": 0
      }
    ]
  }
}

default

Error response

application/json

Schema

Schema

message stringrequired
code stringrequired
issues object[]
Array [
message stringrequired
]

Example (from schema)

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Loading...