Sign in
diagnostics

view operational information

Changed on
<h3>Administrator views the Security Server's operational information on diagnostics page</h3>
get/diagnostics/operational-monitoring

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/diagnostics/operational-monitoring
  • Auth: API key in header Authorization

Query parameters

records_fromstring date-time required
Example:2025-05-15T00:00:00.001Z

the earliest time for the queried requests being made

records_tostring date-time required
Example:2025-05-15T00:00:00.001Z

the latest time for the queried requests being made

intervalinteger required

interval in minutes the requests are divided into

security_server_typestring text

whether this Security Server was a 'Client' or a 'Producer'

member_idstring text

clientId of the Member who made or received the request. <instance_id>:<member_class>:<member_code>:<subsystem_code>. Subsystem code is optional.

service_idstring text

serviceId of the Service that received the request. <instance_id>:<member_class>:<member_code>:<subsystem_code>:<service_code>.<version_number>. Version number is optional.

Response

operational information to be visualized

interval_start_timestring date-time

The beginning of this time window

success_countinteger

number of successful requests in this time window

failure_countinteger

number of failed requests in this time window

Changes