impacts

Creates, updates, deletes, gets or lists an impacts resource.

Overview

Name	impacts
Type	Resource
Id	pagerduty.status_pages.impacts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	An unique identifier within Status Page scope that defines a Impact entry.
description	string	The description is a human-readable text that describes the Impact level.
post_type	string	The type of the Post. (incident, maintenance)
self	string	The API resource URL of the Impact.
status_page	object	Status Page
type	string	The type of the object returned by the API - in this case, a Status Page Impact.

list

Name	Datatype	Description
id	string	An unique identifier within Status Page scope that defines a Impact entry.
description	string	The description is a human-readable text that describes the Impact level.
post_type	string	The type of the Post. (incident, maintenance)
self	string	The API resource URL of the Impact.
status_page	object	Status Page
type	string	The type of the object returned by the API - in this case, a Status Page Impact.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, impact_id		Get an Impact for a Status Page by Status Page ID and Impact ID.<br /><br />Scoped OAuth requires: status_pages.read<br />
list	select	id	post_type	List Impacts for a Status Page by Status Page ID.<br /><br />Scoped OAuth requires: status_pages.read<br />

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
id	string	The ID of the resource.
impact_id	string	The ID of the Status Page Impact.
post_type	string	Filter by Post type.

SELECT examples

get

Get an Impact for a Status Page by Status Page ID and Impact ID.<br /><br />Scoped OAuth requires: status_pages.read<br />

SELECT
id,
description,
post_type,
self,
status_page,
type
FROM pagerduty.status_pages.impacts
WHERE id = '{{ id }}' -- required
AND impact_id = '{{ impact_id }}' -- required
;

list

List Impacts for a Status Page by Status Page ID.<br /><br />Scoped OAuth requires: status_pages.read<br />

SELECT
id,
description,
post_type,
self,
status_page,
type
FROM pagerduty.status_pages.impacts
WHERE id = '{{ id }}' -- required
AND post_type = '{{ post_type }}'
;