raw_incidents_responses
Creates, updates, deletes, gets or lists a raw_incidents_responses
resource.
Overview
Name | raw_incidents_responses |
Type | Resource |
Id | pagerduty.analytics.raw_incidents_responses |
Fields
The following fields are returned by SELECT
queries:
- get_analytics_incident_responses_by_id
Name | Datatype | Description |
---|---|---|
responder_id | string | ID of the user associated with the Incident Response. |
responder_name | string | Name of the user associated with the Incident Response. |
requested_at | string | Timestamp of when the user was requested. |
responded_at | string | Timestamp of when the user responded to the request. |
responder_type | string | Type of responder, where assigned means the user was added to the Incident via Assignment at Incident creation, reassigned means the user was added to the Incident via Reassignment, escalated means the user was added via Escalation, and added_responder means the user was added via Responder Reqeuest. |
response_status | string | Status of the user's interaction with the Incident notification. |
time_to_respond_seconds | integer | Measures the time it took for the user to respond to the Incident request. In other words, responded_at - requested_at . |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_analytics_incident_responses_by_id | select | id | Provides enriched responder data for a single incident. Example metrics include Time to Respond, Responder Type, and Response Status. See metric definitions below. <!-- 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 incident responses appear in the Analytics API. Scoped OAuth requires: analytics.read | |
_get_analytics_incident_responses_by_id | exec | id | Provides enriched responder data for a single incident. Example metrics include Time to Respond, Responder Type, and Response Status. See metric definitions below. <!-- 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 incident responses 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_incident_responses_by_id
Provides enriched responder data for a single incident.
Example metrics include Time to Respond, Responder Type, and Response Status. See metric definitions below.
<!-- 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 incident responses appear in the Analytics API.
Scoped OAuth requires: analytics.read
SELECT
responder_id,
responder_name,
requested_at,
responded_at,
responder_type,
response_status,
time_to_respond_seconds
FROM pagerduty.analytics.raw_incidents_responses
WHERE id = '{{ id }}' -- required
;
Lifecycle Methods
- _get_analytics_incident_responses_by_id
Provides enriched responder data for a single incident.
Example metrics include Time to Respond, Responder Type, and Response Status. See metric definitions below.
<!-- 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 incident responses appear in the Analytics API.
Scoped OAuth requires: analytics.read
EXEC pagerduty.analytics.raw_incidents_responses._get_analytics_incident_responses_by_id
@id='{{ id }}' --required
@@json=
'{
"limit": {{ limit }},
"order": "{{ order }}",
"order_by": "{{ order_by }}",
"time_zone": "{{ time_zone }}"
}'
;