Get aggregated metrics for all users

Provides aggregated metrics across all users within their account. This endpoint provides summary statistics about user activity and performance.

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?

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.

Default"desc"

Value in

"asc"
"desc"

order_by?string

The column that was used for ordering the results.

Default"user_id"

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"

limit?integer

The maximum number of results to return per page. The default (and maximum allowed value) is 1000.

Default1000

starting_after?|

A cursor used for pagination. Starting after cursor provides the next set of results in forward pagination order.

ending_before?|

A cursor used for pagination. Ending before cursor provides the previous set of results in reverse pagination order.

Response Body

`application/json`

curl -X POST "https://api.pagerduty.com/analytics/metrics/users/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-08-07T00:00:00-07:00",      "created_at_end": "2025-08-05T23:59:59-07:00"    },    "time_zone": "America/Chicago"  }'

{  "data": [    {      "total_downloaded_mobile_app_count": 0,      "total_downloaded_mobile_app_percentage": 0,      "total_on_escalation_policy_count": 0,      "total_on_escalation_policy_percentage": 0,      "total_signed_up_count": 14,      "total_signed_up_percentage": 70,      "total_user_count": 20,      "total_with_notification_methods_count": 5,      "total_with_notification_methods_percentage": 25    }  ],  "filters": {    "created_at_start": "2024-08-07T07:00:00Z",    "created_at_end": "2025-08-06T06:59:59Z"  },  "time_zone": "America/Chicago"}

Get aggregated metrics for all users

Authorization

Header Parameters

Request Body

Response Body

200application/json

400application/json

429application/json

`application/json`

`application/json`

`application/json`