url_slugs_service_impacts

Creates, updates, deletes, gets or lists a url_slugs_service_impacts resource.

Overview

Name	url_slugs_service_impacts
Type	Resource
Id	pagerduty.status_dashboards.url_slugs_service_impacts

Fields

The following fields are returned by SELECT queries:

get_status_dashboard_service_impacts_by_url_slug

Name	Datatype	Description
id	string
name	string
additional_fields	object
status	string	The current impact status of the object
type	string	The kind of object that has been impacted

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_status_dashboard_service_impacts_by_url_slug	select	url_slug, X-EARLY-ACCESS	Accept, additional_fields[]	Get Business Service Impacts for the Business Services on a Status Dashboard by its url_slug. A url_slug is a human-readable reference for a custom Status Dashboard that may be created or changed in the UI. It will generally be a dash-separated-string-like-this. This endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted on the Status Dashboard up to the limit of 200. The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name. To get impact information about a specific Business Service on the Status Dashboard that does not appear in the Impact-sored response, use the ids[] parameter on the /business_services/impacts endpoint. <!-- 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_status_dashboard_service_impacts_by_url_slug	exec	url_slug, X-EARLY-ACCESS	Accept, additional_fields[]	Get Business Service Impacts for the Business Services on a Status Dashboard by its url_slug. A url_slug is a human-readable reference for a custom Status Dashboard that may be created or changed in the UI. It will generally be a dash-separated-string-like-this. This endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted on the Status Dashboard up to the limit of 200. The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name. To get impact information about a specific Business Service on the Status Dashboard that does not appear in the Impact-sored response, use the ids[] parameter on the /business_services/impacts endpoint. <!-- 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 status-dashboards. Do not use this endpoint in production, as it may change!
url_slug	string	The url_slug for a status dashboard
Accept	string	The Accept header is used as a versioning header.
additional_fields[]	string	Provides access to additional fields such as highest priority per business service and total impacted count

SELECT examples

get_status_dashboard_service_impacts_by_url_slug

Get Business Service Impacts for the Business Services on a Status Dashboard by its url_slug. A url_slug is a human-readable reference
for a custom Status Dashboard that may be created or changed in the UI. It will generally be a dash-separated-string-like-this.

This endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted on the Status Dashboard up to the limit of 200.

The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name.

To get impact information about a specific Business Service on the Status Dashboard that does not appear in the Impact-sored response, use the ids[] parameter on the /business_services/impacts endpoint.

<!-- 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,
name,
additional_fields,
status,
type
FROM pagerduty.status_dashboards.url_slugs_service_impacts
WHERE url_slug = '{{ url_slug }}' -- required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
AND Accept = '{{ Accept }}'
AND additional_fields[] = '{{ additional_fields[] }}'
;

Lifecycle Methods

_get_status_dashboard_service_impacts_by_url_slug

Get Business Service Impacts for the Business Services on a Status Dashboard by its url_slug. A url_slug is a human-readable reference
for a custom Status Dashboard that may be created or changed in the UI. It will generally be a dash-separated-string-like-this.

This endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted on the Status Dashboard up to the limit of 200.

The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name.

To get impact information about a specific Business Service on the Status Dashboard that does not appear in the Impact-sored response, use the ids[] parameter on the /business_services/impacts endpoint.

<!-- 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.status_dashboards.url_slugs_service_impacts._get_status_dashboard_service_impacts_by_url_slug 
@url_slug='{{ url_slug }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, 
@Accept='{{ Accept }}', 
@additional_fields[]='{{ additional_fields[] }}'
;