metrics_incidents_all
Creates, updates, deletes, gets or lists a metrics_incidents_all resource.
Overview
| Name | metrics_incidents_all |
| Type | Resource |
| Id | pagerduty.analytics.metrics_incidents_all |
Fields
The following fields are returned by SELECT queries:
- get_analytics_metrics_incidents_all
| Name | Datatype | Description |
|---|---|---|
aggregate_unit | string | The time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period. (example: day) |
data | array | |
filters | object | Accepts a set of filters to apply to the Incidents before aggregating. Any incidents that do not match the included filters will be omitted from the results |
time_zone | string | The time zone to use for the results and grouping. (example: Etc/UTC) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_analytics_metrics_incidents_all | select | Provides aggregated enriched metrics for incidents. The provided metrics are aggregated by day, week, month using the aggregate_unit parameter, or for the entire period if no aggregate_unit is provided. <!-- 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 |
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 |
|---|
SELECT examples
- get_analytics_metrics_incidents_all
Provides aggregated enriched metrics for incidents.
The provided metrics are aggregated by day, week, month using the aggregate_unit parameter, or for the entire period if no aggregate_unit is provided.
<!-- 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
aggregate_unit,
data,
filters,
time_zone
FROM pagerduty.analytics.metrics_incidents_all
;