raw_incidents
Creates, updates, deletes, gets or lists a raw_incidents
resource.
Overview
Name | raw_incidents |
Type | Resource |
Id | pagerduty.analytics.raw_incidents |
Fields
The following fields are returned by SELECT
queries:
- get_analytics_incidents_by_id
- get_analytics_incidents
Name | Datatype | Description |
---|
Name | Datatype | Description |
---|---|---|
data | array | |
filters | object | A collection of filters that were applied to the results. |
first | string | Cursor to identify the first object in the response. |
last | string | Cursor to identify the last object in the response. |
limit | integer | Number of results to include in the batch. |
more | boolean | Indicates if there are more resources available than were returned. |
order | string | The order in which the results were sorted; asc for ascending, desc for descending. |
order_by | string | The column that was used for ordering the results. |
time_zone | string | The time zone that the results are in. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_analytics_incidents_by_id | select | id | Provides enriched incident data and metrics for a single incident. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our Knowledge Base. <!-- 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. <!-- theme: info --> > Note: Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: analytics.read | |
get_analytics_incidents | select | Provides enriched incident data and metrics for multiple incidents. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our Knowledge Base. <!-- 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. <!-- theme: info --> > A team_ids or service_ids filter is required for user-level API keys or keys generated through an OAuth flow. Account-level API keys do not have this requirement.<!-- theme: info --> > Note: Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: analytics.read | ||
_get_analytics_incidents_by_id | exec | id | Provides enriched incident data and metrics for a single incident. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our Knowledge Base. <!-- 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. <!-- theme: info --> > Note: Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: analytics.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 |
---|---|---|
id | string | The ID of the resource. |
SELECT
examples
- get_analytics_incidents_by_id
- get_analytics_incidents
Provides enriched incident data and metrics for a single incident.
Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our Knowledge Base.
<!-- 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.
<!-- theme: info -->
> Note: Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.
Scoped OAuth requires: analytics.read
SELECT
*
FROM pagerduty.analytics.raw_incidents
WHERE id = '{{ id }}' -- required
;
Provides enriched incident data and metrics for multiple incidents.
Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our Knowledge Base.
<!-- 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.
<!-- theme: info -->
> A team_ids
or service_ids
filter is required for user-level API keys or keys generated through an OAuth flow. Account-level API keys do not have this requirement.
<!-- theme: info -->
> Note: Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.
Scoped OAuth requires: analytics.read
SELECT
data,
filters,
first,
last,
limit,
more,
order,
order_by,
time_zone
FROM pagerduty.analytics.raw_incidents
;
Lifecycle Methods
- _get_analytics_incidents_by_id
Provides enriched incident data and metrics for a single incident.
Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our Knowledge Base.
<!-- 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.
<!-- theme: info -->
> Note: Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.
Scoped OAuth requires: analytics.read
EXEC pagerduty.analytics.raw_incidents._get_analytics_incidents_by_id
@id='{{ id }}' --required
;