Basic Parameters
| Parameter | Description |
|---|---|
| Alert Key | Alert de-duplication key. |
| ID | ID of the incident. |
| Include | Array of additional details to include. |
| Sort By | Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. |
| Statuses | Return only alerts with the given statuses. (More status codes may be introduced in the future.). |
Advanced Parameters
| Parameter | Description |
|---|---|
| Limit | The number of results per page. |
| Offset | Offset to start pagination search results. |
| Total | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information. |
Example Output
{
"alerts": [
{
"id": "PT4KHLK",
"type": "alert",
"summary": "The server is on fire.",
"self": "https://api.pagerduty.com/incidents/PT4KHLK/alerts/PXPGF42",
"html_url": "https://subdomain.pagerduty.com/alerts/PXPGF42",
"created_at": "2015-10-06T21:30:42Z",
"status": "resolved",
"alert_key": "baf7cf21b1da41b4b0221008339ff357",
"service": {
"id": "PIJ90N7",
"type": "service_reference",
"summary": "My Mail Service",
"self": "https://api.pagerduty.com/services/PIJ90N7",
"html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7"
},
"body": {
"type": "alert_body",
"contexts": [
{
"type": "link"
}
],
"details": {
"customKey": "Server is on fire!",
"customKey2": "Other stuff!"
}
},
"incident": {
"id": "PT4KHLK",
"type": "incident_reference"
},
"suppressed": false,
"severity": "critical",
"integration": {
"id": "PQ12345",
"type": "generic_email_inbound_integration_reference",
"summary": "Email Integration",
"self": "https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345",
"html_url": "https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345"
}
}
],
"limit": 1,
"offset": 0,
"more": true
}
Workflow Library Example
List Alerts with Pagerduty and Send Results Via Email