Get aggregated incident data

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.

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.

Note: Data availability reflects pipeline processing cycles and is generally within 24 hours under normal conditions.

Scoped OAuth requires: analytics.write

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"

Content-Type*"application/json"

Default"application/json"

Value in

"application/json"

Request Body

application/json

Parameters and filters to apply to the dataset.

TypeScript Definitions

Use the request body type in TypeScript.

filters?

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. Must be in tzdata format. See list of accepted values here.

order?string

The order in which the results were sorted; asc for ascending, desc for descending.

Value in

"asc"
"desc"

order_by?string

The column that was used for ordering the results.

aggregate_unit?|

The time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period.

Value in

"day"
"week"
"month"

Response Body

`application/json`

curl -X POST "https://api.pagerduty.com/analytics/metrics/incidents/all" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "created_at_start": "2024-01-01T00:00:00-05:00",      "created_at_end": "2024-01-31T00:00:00-05:00",      "urgency": "high",      "major": true,      "team_ids": [        "PGVXG6U",        "PNVU4U4"      ],      "service_ids": [        "PQVUB8D",        "PU2D9X3"      ]    },    "aggregate_unit": "day",    "time_zone": "Etc/UTC"  }'

{  "aggregate_unit": "day",  "data": [    {      "mean_assignment_count": 1,      "mean_engaged_seconds": 366,      "mean_engaged_user_count": 1,      "mean_seconds_to_engage": 81,      "mean_seconds_to_first_ack": 63,      "mean_seconds_to_mobilize": 41,      "mean_seconds_to_resolve": 380,      "mean_user_defined_engaged_seconds": 366,      "range_start": "2024-01-01T00:00:00",      "total_business_hour_interruptions": 81,      "total_engaged_seconds": 3591,      "total_escalation_count": 5,      "total_incident_count": 124,      "total_incidents_acknowledged": 0,      "total_incidents_auto_resolved": 0,      "total_incidents_manual_escalated": 0,      "total_incidents_reassigned": 0,      "total_incidents_timeout_escalated": 0,      "total_interruptions": 2,      "total_notifications": 2,      "total_off_hour_interruptions": 20,      "total_sleep_hour_interruptions": 21,      "total_snoozed_seconds": 78,      "total_user_defined_engaged_seconds": 3591    }  ],  "filters": {    "create_range_start": "2024-01-01T00:00:00Z",    "create_range_end": "2024-02-01T00:00:00Z",    "urgency": "high",    "major": true,    "team_ids": [      "PGVXG6U",      "PNVU4U4"    ],    "service_ids": [      "PQVUB8D",      "PU2D9X3"    ]  },  "time_zone": "Etc/UTC"}

Get aggregated incident data

Authorization

Header Parameters

Request Body

Response Body

200application/json

400application/json

429application/json

`application/json`

`application/json`

`application/json`