POST /analytics/raw/incidents
Provides enriched incident data and metrics for multiple incidents.
Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our Knowledge Base.
A
team_ids
orservice_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: Analytics data is updated periodically. It takes up to 24 hours before new incidents appear in the Analytics API.
Scoped OAuth requires: analytics.read
Servers
- https://api.pagerduty.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Accept |
String | Yes |
The Default value: "application/vnd.pagerduty+json;version=2" |
Content-Type |
String | Yes |
Possible values:
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
filters |
Object | No |
Filters the result, only show incidents that match the conditions passed in the filter. |
filters.updated_after |
String | No |
Filters the result, showing only incidents where the updated_at value is greater than the filter value. |
filters.urgency |
String | No |
Filters the result, showing only the incidents where urgency matches the filter value. |
filters.major |
Boolean | No |
An incident is classified as a major incident if it has one of the two highest priorities, or if multiple responders are added and acknowledge the incident. |
filters.incident_type_ids[] |
Array | No |
Filter incidents by specific incident type IDs. Only incidents matching the given IDs will be returned. |
filters.priority_ids[] |
Array | No |
The priority_ids filter applied to the results. |
filters.created_at_end |
String | No |
Filters the result, showing only the incidents where the creation timestamp is less than the filter value. |
filters.service_ids[] |
Array | No |
An array of service IDs. Only results related to these services will be returned. |
filters.team_ids[] |
Array | No |
An array of team IDs. Only incidents that are assigned to a member of these teams will be returned. Account must have the teams ability to use this parameter. |
filters.created_at_start |
String | No |
Filters the result, showing only the incidents where the creation timestamp is greater than or equal to the filter value. |
filters.priority_names[] |
Array | No |
The priority_names filter applied to the results. |
time_zone |
String | No |
The time zone to use for the results. |
order |
String | No |
The order the results; asc for ascending, desc for descending. Defaults to 'desc'. Possible values:
|
limit |
Integer | No |
Number of results to include in each batch. Limits between 1 to 1000 are accepted. |
starting_after |
String | No |
A cursor to indicate the reference point that the results should follow |
ending_before |
String | No |
A cursor to indicate the reference point that the results should precede |
order_by |
String | No |
The column to use for ordering the results. Defaults to 'created_at'. Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.