PAGERDUTY_AGGREGATE_INCIDENT_METRICS_WITH_FILTERS

Retrieves and aggregates metrics for incidents across all services in PagerDuty. This endpoint allows for extensive filtering and customization of incident data, enabling detailed analysis of operational performance. It's particularly useful for generating reports, identifying trends, and assessing incident management efficiency over specified time periods. The endpoint supports various filtering criteria, time zone adjustments, and aggregation options, making it a powerful tool for both high-level overviews and granular incident analytics. However, users should be aware of the complexity of the filtering options and ensure they provide accurate parameters to obtain relevant data.

Available from 1 provider (1 remote)

Input Schema

            {
  "type": "object",
  "properties": {
    "order": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "title": "Order",
      "description": "The order in which the results were sorted; asc for ascending, desc for descending. "
    },
    "order_by": {
      "type": "string",
      "title": "Order By",
      "description": "The column that was used for ordering the results."
    },
    "time_zone": {
      "type": "string",
      "title": "Time Zone",
      "description": "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). "
    },
    "aggregate_unit": {
      "enum": [
        "day",
        "week",
        "month"
      ],
      "type": "string",
      "title": "Aggregate Unit",
      "description": "The time unit to aggregate metrics by.  If no value is provided, the metrics will be aggregated for the entire period. "
    },
    "filters__major": {
      "type": "boolean",
      "title": "Filters  Major",
      "description": "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. "
    },
    "filters__urgency": {
      "enum": [
        "high",
        "low"
      ],
      "type": "string",
      "title": "Filters  Urgency",
      "description": "Any incidents whose urgency does not match the provided string will be omitted from the results. "
    },
    "filters__team__ids": {
      "type": "array",
      "items": {
        "type": "string",
        "properties": {}
      },
      "title": "Filters  Team  Ids",
      "description": "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. "
    },
    "filters__service__ids": {
      "type": "array",
      "items": {
        "type": "string",
        "properties": {}
      },
      "title": "Filters  Service  Ids",
      "description": "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. "
    },
    "filters__priority__ids": {
      "type": "array",
      "items": {
        "type": "string",
        "properties": {}
      },
      "title": "Filters  Priority  Ids",
      "description": "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. "
    },
    "filters__priority__names": {
      "type": "array",
      "items": {
        "type": "string",
        "properties": {}
      },
      "title": "Filters  Priority  Names",
      "description": "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. "
    },
    "filters__created__at__end": {
      "type": "string",
      "title": "Filters  Created  At  End",
      "description": "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 created_at_start is one year. "
    },
    "filters__pd__advance__used": {
      "type": "boolean",
      "title": "Filters  Pd  Advance  Used",
      "description": "If true, only incidents where PD Advance was used will be included in the results, and vice versa. If omitted, all incidents will be included. "
    },
    "filters__created__at__start": {
      "type": "string",
      "title": "Filters  Created  At  Start",
      "description": "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 created_at_end is one year. "
    },
    "filters__min__ackowledgements": {
      "type": "integer",
      "title": "Filters  Min  Ackowledgements",
      "description": "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. "
    },
    "filters__escalation__policy__ids": {
      "type": "array",
      "items": {
        "type": "string",
        "properties": {}
      },
      "title": "Filters  Escalation  Policy  Ids",
      "description": "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. "
    },
    "filters__min__manual__escalations": {
      "type": "integer",
      "title": "Filters  Min  Manual  Escalations",
      "description": "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. "
    },
    "filters__min__timeout__escalations": {
      "type": "integer",
      "title": "Filters  Min  Timeout  Escalations",
      "description": "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. "
    }
  }
}