user_metrics
Creates, updates, deletes, gets or lists a user_metrics resource.
Overview​
| Name | user_metrics |
| Type | Resource |
| Id | pagerduty.analytics.user_metrics |
Fields​
The following fields are returned by SELECT queries:
- list
Returns user metrics aggregated across the account
| Name | Datatype | Description |
|---|---|---|
total_downloaded_mobile_app_count | integer | The number of users who have downloaded the mobile app. |
total_downloaded_mobile_app_percentage | number (float) | The percentage of users who have downloaded the mobile app. |
total_on_escalation_policy_count | integer | The number of users who are on at least one escalation policy. |
total_on_escalation_policy_percentage | number (float) | The percentage of users who are on at least one escalation policy. |
total_signed_up_count | integer | The number of users who have signed up (completed onboarding). |
total_signed_up_percentage | number (float) | The percentage of users who have signed up. |
total_user_count | integer | The total number of users in the account that match the filters. |
total_with_notification_methods_count | integer | The number of users who have at least one notification method configured. |
total_with_notification_methods_percentage | number (float) | The percentage of users who have at least one notification method configured. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | Provides aggregated metrics across all users within their account. This endpoint provides summary statistics about user activity and performance.<br /><br /><!-- theme: info --><br />> Note: Data availability reflects [pipeline processing cycles](https:​//support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions.<br /><br />Scoped OAuth requires: analytics.write<br /> |
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​
- list
Provides aggregated metrics across all users within their account. This endpoint provides summary statistics about user activity and performance.<br /><br /><!-- theme: info --><br />> Note: Data availability reflects [pipeline processing cycles](https:​//support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions.<br /><br />Scoped OAuth requires: analytics.write<br />
SELECT
total_downloaded_mobile_app_count,
total_downloaded_mobile_app_percentage,
total_on_escalation_policy_count,
total_on_escalation_policy_percentage,
total_signed_up_count,
total_signed_up_percentage,
total_user_count,
total_with_notification_methods_count,
total_with_notification_methods_percentage
FROM pagerduty.analytics.user_metrics
;