"listStreamingConnectionProblems"
View a streaming connection's errors and warnings
The "listStreamingConnectionProblems" action returns a streaming connection's errors and/or warnings. The list can be filtered by time and connection.
This action ANDs together all the filter properties to create the filter. Omit a filter property or set it to null to prevent it from filtering the results. Omit all filters to return all problems with all data change streams.
The "problemTypeFilter" property contains a list of problem types that the server ORs together, such as [ "fatalException", "error", "warning" ].
You can omit
"startTimestamp"and"endTimestamp"to return problems unfiltered by time.You can supply
"startTimestamp"and omit"endTimestamp"to return problems from the specified start timestamp onward.You can supply
"startTimestamp"and"endTimestamp"to return problems between both timestamps (inclusive).
Request examples
Minimal
This example returns all problems from all data change streams.
{
"api": "admin",
"action": "listStreamingConnectionProblems",
"params": {},
"authToken": "replaceWithAuthTokenFromCreateSession"
}
This example returns errors and warnings for the "fmq" streaming connection between midnight and 08:00 on 2025-08-19.
{
"api": "admin",
"action": "listStreamingConnectionProblems",
"params": {
"problemTypeFilter": [ "error", "fatalException", "warning" ],
"streamingConnectionNameFilter": "fmq",
"startTimestamp": "2025-08-19T00:00:00.000",
"endTimestamp": "2025-08-19T08:00:00.000"
},
"authToken": "replaceWithAuthTokenFromCreateSession"
}
{
"authToken": "authToken",
"result": {
"startTimestamp": "2025-08-19T00:00:00.000",
"endTimestamp": "2025-08-19T16:21:54.013",
"streamingConnectionNameFilter": "fmq"
"problems": [
{
"problemTimestamp": "2025-08-19T03:17:45.000",
"problemType": "error",
"problemCode": 88455,
"problemMessage": "some error message",
"problemData": {"key": "value"}
},
{
"problemTimestamp": "2025-08-19T03:17:45.000",
"problemType": "warning",
"problemCode": 0,
"problemMessage": "some warning message",
"problemData": {"key": "value"}
}
]
},
"errorCode": 0,
"errorMessage": ""
}
"params" property summariesProperty | Description | Default | Type | Limits (inclusive) | |||||
|---|---|---|---|---|---|---|---|---|---|
(optional) filters problems to end before or on its value. You must supply a complete date. If you omit parts of the time, the server defaults the remaining parts to |
| string containing an ISO8601 timestamp | Examples
| ||||||
(optional) filters the response to match the specified types of problems. Omit or set to |
| array of strings |
| ||||||
(optional) filters problems to start on or after its value. You must supply a complete date. If you omit parts of the time, the server defaults the remaining parts to |
| string containing an ISO8601 timestamp | Examples
| ||||||
(optional) specifies a partial match for a connection name. |
| string | 1 to 64 bytes |
The "endTimestamp" property is an optional string that contains an ISO8601 timestamp, which filters the response to return problems that ended before or on its value. If any parts of the timestamp are missing or omitted, the server defaults the remaining parts to 0.
The "problemTypeFilter" property is an optional array of strings that filters the response to match the specified types of problems. You may omit this property or set it to null to return all problem types.
The "startTimestamp" property is an optional string that contains an ISO8601 timestamp, which filters the response to return problems that started on or after its value. If any parts of the timestamp are missing or omitted, the server defaults the remaining parts to 0.
The "streamingConnectionNameFilter" property is an optional string that specifies a partial match for a connection name.
"result" property summariesProperty | Description | Type | Contents | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
filters problems to end before or on its value. You must supply a complete date. If you omit parts of the time, the server defaults the remaining parts to | string containing an ISO8601 timestamp | Examples
| ||||||||
lists problems that match the request parameters. Each problem is contained in a separate object. | array of objects | 0 or more objects | ||||||||
| specifies a unique code number that identifies the type of problem. | integer | A unique code number | |||||||
| contains data about the problem stored in a JSON object. | object | 1 or more key/value pairs | |||||||
| contains a message describing the problem. | string | A message detailing the problem | |||||||
| lists the date and time the problem occurred. | string containing an ISO8601 timestamp | Examples
| |||||||
| details the type of problem, such as an error or warning. | string |
| |||||||
filters problems to start on or after its value. You must supply a complete date. If you omit parts of the time, the server defaults the remaining parts to | string containing an ISO8601 timestamp | Examples
| ||||||||
specifies a partial match for a connection name. | string | 1 to 64 bytes |
The "endTimestamp" property is an optional string that contains an ISO8601 timestamp, which filters the response to return problems that ended before or on its value. If any parts of the timestamp are missing or omitted, the server defaults the remaining parts to 0.
The "problems" property is an array of objects that lists problems that match the request parameters. Each problem is contained in a separate object.
"problems": [
{
"problemTimestamp": "2025-08-19T03:17:45.000",
"problemType": "error",
"problemCode": 88455,
"problemMessage": "some error message",
"problemData": {"key": "value"}
},
The "problemCode" property is an integer that specifies a unique code number that identifies the type of problem.
The "problemData" property is an object that contains data about the problem stored in a JSON object. The data is stored in the object as key/value pairs.
The "problemMessage" property is a string that contains a message describing the problem.
The "problemTimestamp" property is a string that lists the date and time the problem occurred. The timestamp is formatted as an ISO8601 timestamp embedded in the string.
The "problemType" property is a string that details the type of problem that occurred, such as an error or warning.
The "startTimestamp" property is an optional string that contains an ISO8601 timestamp, which filters the response to return problems that started on or after its value. If any parts of the timestamp are missing or omitted, the server defaults the remaining parts to 0.
The "streamingConnectionNameFilter" property is an optional string that specifies a partial match for a connection name.