Skip to main content

​
Overview

The get_alert_grouping_setting tool retrieves detailed information about a specific alert grouping setting, including its configuration, type, and associated services.
This is a read-only tool that does not modify any data in your PagerDuty account.

​
Parameters

​
setting_id
string
required
The unique identifier of the alert grouping setting to retrieve.Example: "PAGRSET1"

​
Response

Returns a detailed alert grouping setting object.
​
id
string
The unique identifier of the alert grouping setting
​
type
string
The type of alert grouping configuration. Options:
  • content_based - Group alerts by matching specific field values
  • content_based_intelligent - Intelligent grouping combined with field matching
  • intelligent - AI-powered intelligent alert grouping
  • time - Group alerts within a time window
​
name
string
A short-form name suitable for labeling the alert grouping setting
​
description
string
A description providing additional information about the alert grouping setting
​
config
object
The configuration object containing settings specific to the grouping type.
​
services
array
Array of service references that this alert grouping setting applies to. Note: content_based_intelligent type allows only one service.
​
created_at
datetime
The ISO8601 date/time when the alert grouping setting was created
​
updated_at
datetime
The ISO8601 date/time when the alert grouping setting was last updated

​
Example Usage

"Show me the details of alert grouping setting PAGRSET1"

​
Use Cases

  • Review configuration - Examine how alerts are grouped for specific services
  • Troubleshoot grouping - Understand why alerts are or aren’t being grouped
  • Compare settings - Analyze different grouping strategies across services
  • Audit compliance - Verify grouping settings meet requirements
  • Optimize performance - Review time windows and field matching

​
Response Example

{
  "id": "PAGRSET1",
  "type": "content_based",
  "name": "Production API Grouping",
  "description": "Groups production API alerts by component and severity",
  "config": {
    "aggregate": "all",
    "fields": ["component", "severity"],
    "time_window": 3600,
    "recommended_time_window": 900
  },
  "services": [
    {
      "id": "PSVC123",
      "type": "service_reference"
    }
  ],
  "created_at": "2024-01-01T10:00:00Z",
  "updated_at": "2024-01-15T14:30:00Z"
}

​
Important Notes

  • The content_based_intelligent type supports only one service per setting
  • Setting time_window to 0 uses the recommended time window calculated by PagerDuty
  • The recommended_time_window is calculated based on your service’s alert patterns
  • Field names in fields must match the structure of alerts sent to the service

Build docs developers (and LLMs) love

Get started for freeTalk to us