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.
{
"action": "listStreamingConnectionProblems",
"params": {},
"authToken": "replaceWithAuthTokenFromCreateSession"
}Maximal
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"
}
Response examples
Maximal
{
"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": ""
}
Properties
Request properties ("params")
| Property | Description | Default | Type | Limits (inclusive) |
|---|---|---|---|---|
endTimestamp |
The |
Optional with default of null
|
string containing an ISO8601 timestamp |
|
problemTypeFilter |
The |
Optional with default of null
|
array of strings |
|
startTimestamp |
The |
Optional with default of null
|
string containing an ISO8601 timestamp |
|
streamingConnectionNameFilter |
The |
Optional with default of null
|
string | 1 to 64 bytes |
Response properties ("result")
| Property | Description | Type | Limits (inclusive) |
|---|---|---|---|
endTimestamp |
The
|
string containing an ISO8601 timestamp |
|
problems |
The "problems" property lists problems that match the request parameters. Each problem is contained in a separate object. |
array of objects |
0 or more objects containing 1 or more of the following properties:
|
|
problems .problemCode |
The |
integer | A unique code number |
|
problems .problemData |
The |
object | 1 or more key/value pairs |
|
problems .problemMessage |
The |
string | A message detailing the problem |
|
problems .problemTimestamp |
The |
string containing an ISO8601 timestamp |
|
|
problems .problemType |
The |
string |
|
startTimestamp |
The "startTimestamp" property specifies the time at which the query was initiated. |
timestamp | A timestamp |
streamingConnectionNameFilter |
The "streamingConnectionNameFilter" property specifies a partial match for a connection name. |
string | 1 to 64 bytes |