How Can We Help?
This section describes usage of Query APIs to get information on signals which are part of workload or behavior events.
Details of Signals
To get time-series details of all the signals for an application in an account, use the ‘signals’ Query API as follows:
API Name – signals
Format – GET /config/accounts/{accountId}/applications/{applicationId}/signals
Input Parameters
| Type | Name | Description | Schema | Mandatory / Optional |
| Path | accountId | ID or Identifier of an Account | string | Mandatory |
| Path | applicationId | ID or Identifier of an application | string | Mandatory |
| Query | from | Time Range in GMT format | string | Mandatory |
| Query | to | string | Mandatory | |
| Query | signalType | It can be “PROBLEM” or “EARLY_WARNING” or “ALL”. It is case sensitive. | string | Mandatory |
Output Parameters
- Signal Type – Type of a signal. It can be a problem or an early warning or both.
- Signal ID – Unique ID of a signal
- Severity – Severity of a signal. It can be critical or non-critical
- Description – Description of a signal
- Status – Status of a signal. It can be Open, Closed, or Upgraded
- Started On – Timestamp when the signal was created
- Ended On – Timestamp when the signal was closed
Sample Input
Details of a Signal
To get time-series details of a signal for an account, use the ‘signals’ Query API as follows:
API Name – signals
Format – GET /config/accounts/{accountId}/signals/{signalId}
Input Parameters
| Type | Name | Description | Schema | Mandatory / Optional |
| Path | accountId | ID or Identifier of an Account | string | Mandatory |
| Path | signalId | ID or Identifier of a signal | string | Mandatory |
Output Parameters
Output Type: JSON
- Signal ID – Unique ID of a signal
- Signal Description – Description of a signal
- Signal Type – Type of a signal. It can be a problem or an early warning.
- Severity – Severity of a signal. It can be critical or non-critical
- Status – Status of a signal. It can be Open, Closed, or Upgraded
- Impacted Entry Point Service – Entry point service affected by the events
- Root Cause Services – Service where the events originated
- Affected Services – Services which are affected by the events
- Affected Applications – Applications which are affected by the events
- Related Signals – Signals related to the current signal. They can be problems or early warnings or both.
- Started On – Timestamp when the signal was created
- Ended On – Timestamp when the signal was closed
- Total number of events – Total count of workload and behavior events occurred
- Behavior Events – Details of behavior events
- Workload Events – Details of workload events
Sample Input