---
title: "Get aggregated PD Advance usage data"
method: POST
path: "/analytics/metrics/pd_advance_usage/features"
tags: ["Analytics"]
---

# Get aggregated PD Advance usage data

`POST /analytics/metrics/pd_advance_usage/features`

Provides aggregated metrics for the usage of PD Advance.
<!-- theme: info -->
> **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.

Scoped OAuth requires: `analytics.write`

## Headers

- `Accept` string, required
- `Content-Type` 'application/json', required

## Request body

- AnalyticsPdAdvanceUsageFilter
  - `filters` object — 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.
    - `created_at_start` string — Accepts an ISO8601 DateTime string. Any PD Advance usage with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with created_at_end is one year.
    - `created_at_end` string — Accepts an ISO8601 DateTime string. Any PD Advance usage with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with created_at_start is one year.
    - `incident_created_at_start` string — Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with incident_created_at_end is one year.
    - `incident_created_at_end` string — Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with incident_created_at_start is one year.
    - `urgency` 'high' | 'low' — Any incidents whose urgency does not match the provided string will be omitted from the results.
    - `major` boolean — A boolean flag including whether results should contain *only* [major incidents](https://support.pagerduty.com/docs/operational-reviews#major-incidents), or exclude major incidents. If no value is provided all incidents will be included.
    - `min_ackowledgements` integer — An integer that sets the requirement for the minimum number of acknowledgements to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 acknowledgement. If no value is provided, all incidents will be included.
    - `min_timeout_escalations` integer — An integer that sets the requirement for the minimum number of timeout escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 timeout escalation. If no value is provided, all incidents will be included.
    - `min_manual_escalations` integer — An integer that sets the requirement for the minimum number of manual escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 manual escalation. If no value is provided, all incidents will be included.
    - `team_ids` string[] — An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.
    - `service_ids` string[] — An array of service IDs. Only incidents related to these services will be included in the results. If omitted, all services the requestor has access to will be included in the results.
    - `escalation_policy_ids` string[] — An array of escalation policy IDs. Only incidents related to these escalation policies will be included in the results. If omitted, all escalation policies the requestor has access to will be included in the results.
    - `priority_ids` string[] — An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.
    - `priority_names` string[] — An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in 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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).

## Response `200`

OK

- object
  - `data` object[]
    - `feature_id` string — Which feature of PD Advance was used.
    - `total_credits_used` integer — How many credits were used by this feature.
    - `total_use_count` integer — How many times this feature was used.
    - `total_proactive_credits_used` integer — How many of the credits used were initiated by PD Advance rather than a user.
    - `total_proactive_use_count` integer — How many times this feature was initiated by PD Advance rather than a user.
  - `filters` object — 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.
    - `created_at_start` string — Accepts an ISO8601 DateTime string. Any PD Advance usage with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with created_at_end is one year.
    - `created_at_end` string — Accepts an ISO8601 DateTime string. Any PD Advance usage with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with created_at_start is one year.
    - `incident_created_at_start` string — Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with incident_created_at_end is one year.
    - `incident_created_at_end` string — Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with incident_created_at_start is one year.
    - `urgency` 'high' | 'low' — Any incidents whose urgency does not match the provided string will be omitted from the results.
    - `major` boolean — A boolean flag including whether results should contain *only* [major incidents](https://support.pagerduty.com/docs/operational-reviews#major-incidents), or exclude major incidents. If no value is provided all incidents will be included.
    - `min_ackowledgements` integer — An integer that sets the requirement for the minimum number of acknowledgements to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 acknowledgement. If no value is provided, all incidents will be included.
    - `min_timeout_escalations` integer — An integer that sets the requirement for the minimum number of timeout escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 timeout escalation. If no value is provided, all incidents will be included.
    - `min_manual_escalations` integer — An integer that sets the requirement for the minimum number of manual escalations to occur on an incident. For example, setting this to 1 will return only incidents that have at least 1 manual escalation. If no value is provided, all incidents will be included.
    - `team_ids` string[] — An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.
    - `service_ids` string[] — An array of service IDs. Only incidents related to these services will be included in the results. If omitted, all services the requestor has access to will be included in the results.
    - `escalation_policy_ids` string[] — An array of escalation policy IDs. Only incidents related to these escalation policies will be included in the results. If omitted, all escalation policies the requestor has access to will be included in the results.
    - `priority_ids` string[] — An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in the results.
    - `priority_names` string[] — An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all priorities will be included in 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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).

## Other responses

- `400` — Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work.
- `429` — Too many requests have been made, the rate limit has been reached.

---

[API](https://skmtc.net/pagerduty/apis/rest-api.md) · [All operations](https://skmtc.net/pagerduty/apis/rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pagerduty/rest-api/revisions/b679a8f3f02c/schema)