alerts
Creates, updates, deletes, gets or lists an alerts
resource.
Overview
Name | alerts |
Type | Resource |
Id | pagerduty.paused_incident_reports.alerts |
Fields
The following fields are returned by SELECT
queries:
- get_paused_incident_report_alerts
Paused Incident Reporting on Alerts for the Account or scoped to a Service.
Name | Datatype | Description |
---|---|---|
resolved_after_pause_alerts | array | An array of Alerts that were resolved after being paused. |
since | string | The start of the date range over which the report data is represented. |
triggered_after_pause_alerts | array | An array of Alerts that were triggered after being paused. |
until | string | The end of the date range over which the report data is represented. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_paused_incident_report_alerts | select | Accept , Content-Type , since , until , service_id , suspended_by | Returns the 5 most recent alerts that were triggered after being paused and the 5 most recent alerts that were resolved after being paused for a given reporting period (maximum 6 months lookback period). Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only. For more information see the API Concepts Document Scoped OAuth requires: incidents.read | |
_get_paused_incident_report_alerts | exec | Accept , Content-Type , since , until , service_id , suspended_by | Returns the 5 most recent alerts that were triggered after being paused and the 5 most recent alerts that were resolved after being paused for a given reporting period (maximum 6 months lookback period). Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only. For more information see the API Concepts Document Scoped OAuth requires: incidents.read |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
Accept | string | The Accept header is used as a versioning header. |
Content-Type | string | |
service_id | string | Specifies a filter to limit the scope of reporting to a particular service |
since | string (date-time) | The start of the date range over which you want to search. |
suspended_by |
| Specifies a filter to scope the response to either alerts suspended by Auto Pause or Event Rules. |
until | string (date-time) | The end of the date range over which you want to search. |
SELECT
examples
- get_paused_incident_report_alerts
Returns the 5 most recent alerts that were triggered after being paused and the 5 most recent alerts that were resolved after being paused for a given reporting period (maximum 6 months lookback period). Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only.
For more information see the API Concepts Document
Scoped OAuth requires: incidents.read
SELECT
resolved_after_pause_alerts,
since,
triggered_after_pause_alerts,
until
FROM pagerduty.paused_incident_reports.alerts
WHERE Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
AND since = '{{ since }}'
AND until = '{{ until }}'
AND service_id = '{{ service_id }}'
AND suspended_by = '{{ suspended_by }}'
;
Lifecycle Methods
- _get_paused_incident_report_alerts
Returns the 5 most recent alerts that were triggered after being paused and the 5 most recent alerts that were resolved after being paused for a given reporting period (maximum 6 months lookback period). Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only.
For more information see the API Concepts Document
Scoped OAuth requires: incidents.read
EXEC pagerduty.paused_incident_reports.alerts._get_paused_incident_report_alerts
@Accept='{{ Accept }}',
@Content-Type='{{ Content-Type }}',
@since='{{ since }}',
@until='{{ until }}',
@service_id='{{ service_id }}',
@suspended_by='{{ suspended_by }}'
;