impactors

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

Overview

Name	impactors
Type	Resource
Id	pagerduty.business_services.impactors

Fields

The following fields are returned by SELECT queries:

get_business_service_top_level_impactors

Name	Datatype	Description
id	string
type	string	The kind of object that is impacting

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_business_service_top_level_impactors	select	X-EARLY-ACCESS	Accept, ids[]	Retrieve a list of Impactors for the top-level Business Services on the account. Impactors are currently limited to Incidents. This endpoint does not return an exhaustive list of Impactors but rather provides access to the highest priority Impactors for the Business Services in question up to the limit of 200. To get Impactors for a specific set of Business Services, use the ids[] parameter. The returned Impactors are sorted first by priority and secondarily by their creation date. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
_get_business_service_top_level_impactors	exec	X-EARLY-ACCESS	Accept, ids[]	Retrieve a list of Impactors for the top-level Business Services on the account. Impactors are currently limited to Incidents. This endpoint does not return an exhaustive list of Impactors but rather provides access to the highest priority Impactors for the Business Services in question up to the limit of 200. To get Impactors for a specific set of Business Services, use the ids[] parameter. The returned Impactors are sorted first by priority and secondarily by their creation date. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

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
X-EARLY-ACCESS	string	This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value business-impact-early-access. Do not use this endpoint in production, as it may change!
Accept	string	The Accept header is used as a versioning header.
ids[]	string	The IDs of the resources.

SELECT examples

get_business_service_top_level_impactors

Retrieve a list of Impactors for the top-level Business Services on the account. Impactors are currently limited to Incidents.

This endpoint does not return an exhaustive list of Impactors but rather provides access to the highest priority Impactors for the Business Services in question up to the limit of 200.

To get Impactors for a specific set of Business Services, use the ids[] parameter.

The returned Impactors are sorted first by priority and secondarily by their creation date.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

SELECT
id,
type
FROM pagerduty.business_services.impactors
WHERE X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
AND Accept = '{{ Accept }}'
AND ids[] = '{{ ids[] }}'
;

Lifecycle Methods

_get_business_service_top_level_impactors

Retrieve a list of Impactors for the top-level Business Services on the account. Impactors are currently limited to Incidents.

This endpoint does not return an exhaustive list of Impactors but rather provides access to the highest priority Impactors for the Business Services in question up to the limit of 200.

To get Impactors for a specific set of Business Services, use the ids[] parameter.

The returned Impactors are sorted first by priority and secondarily by their creation date.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

EXEC pagerduty.business_services.impactors._get_business_service_top_level_impactors 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, 
@Accept='{{ Accept }}', 
@ids[]='{{ ids[] }}'
;