Create a Metric Alert Rule for an Organization

Path Parameters

organization_slug (string)

REQUIRED

The slug of the organization the resource belongs to.

Body Parameters

name (string)

REQUIRED

The name for the rule, which has a maximimum length of 256 characters.

aggregate (string)

REQUIRED

A string representing the aggregate function used in this alert rule. Valid aggregate functions are count, count_unique, percentage, avg, apdex, failure_rate, p50, p75, p95, p99, p100, and percentile. See Metric Alert Rule Types for valid configurations.

timeWindow (integer)

REQUIRED

The time period to aggregate over.

• 1 - 1 minute
• 5 - 5 minutes
• 10 - 10 minutes
• 15 - 15 minutes
• 30 - 30 minutes
• 60 - 1 hour
• 120 - 2 hours
• 240 - 4 hours
• 1440 - 24 hours

projects (array(string))

REQUIRED

Metric alerts are currently limited to one project. The array should contain a single slug, representing the project to filter by.

query (string)

REQUIRED

An event search query to subscribe to and monitor for alerts. For example, to filter transactions so that only those with status code 400 are included, you could use "query": "http.status_code:400". Use an empty string for no filter.

thresholdType (integer)

REQUIRED

The comparison operator for the critical and warning thresholds. The comparison operator for the resolved threshold is automatically set to the opposite operator. When a percentage change threshold is used, 0 is equivalent to "Higher than" and 1 is equivalent to "Lower than".

• 0 - Above
• 1 - Below

triggers (array(undefined))

REQUIRED

A list of triggers, where each trigger is an object with the following fields:

• label: One of critical or warning. A critical trigger is always required.
• alertThreshold: The value that the subscription needs to reach to trigger the alert rule.
• actions: A list of actions that take place when the threshold is met. Set as an empty list if no actions are to take place.

JSON

Copied

triggers: [
    {
        "label": "critical",
        "alertThreshold": 50,
        "actions": [
            {
                "type": "slack",
                "targetType": "specific",
                "targetIdentifier": "#get-crit",
                "inputChannelId": 2454362
                "integrationId": 653532,
            }
        ]
    },
    {
        "label": "warning",
        "alertThreshold": 25,
        "actions": []
    }
]

Metric alert rule trigger actions follow the following structure:

• type: The type of trigger action. Valid values are email, slack, msteams, pagerduty, sentry_app, sentry_notification, and opsgenie.
• targetType: The type of target the notification will be sent to. Valid values are specific (targetIdentifier is a direct reference used by the service, like an email address or a Slack channel ID), user (targetIdentifier is a Sentry user ID), team (targetIdentifier is a Sentry team ID), and sentry_app (targetIdentifier is a SentryApp ID).
• targetIdentifier: The ID of the target. This must be an integer for PagerDuty and Sentry apps, and a string for all others. Examples of appropriate values include a Slack channel name (#my-channel), a user ID, a team ID, a Sentry app ID, etc.
• inputChannelId: The ID of the Slack channel. This is only used for the Slack action, and can be used as an alternative to providing the targetIdentifier.
• integrationId: The integration ID. This is required for every action type excluding email and sentry_app.
• sentryAppId: The ID of the Sentry app. This is required when type is sentry_app.
• priority: The severity of the Pagerduty alert or the priority of the Opsgenie alert (optional). Defaults for Pagerduty are critical for critical and warning for warning. Defaults for Opsgenie are P1 for critical and P2 for warning.

environment (string)

The name of the environment to filter by. Defaults to all environments.

dataset (string)

The name of the dataset that this query will be executed on. Valid values are events, transactions, metrics, sessions, and generic-metrics. Defaults to events. See Metric Alert Rule Types for valid configurations.

queryType (integer)

The type of query. If no value is provided, queryType is set to the default for the specified dataset. See Metric Alert Rule Types for valid configurations.

• 0 - event.type:error
• 1 - event.type:transaction
• 2 - None

eventTypes (array(string))

List of event types that this alert will be related to. Valid values are default (events captured using Capture Message), error and transaction.

comparisonDelta (integer)

An optional int representing the time delta to use as the comparison period, in minutes. Required when using a percentage change threshold ("x%" higher or lower compared to comparisonDelta minutes ago). A percentage change threshold cannot be used for Crash Free Session Rate or Crash Free User Rate.

resolveThreshold (number)

Optional value that the metric needs to reach to resolve the alert. If no value is provided, this is set automatically based on the lowest severity trigger's alertThreshold. For example, if the alert is set to trigger at the warning level when the number of errors is above 50, then the alert would be set to resolve when there are less than 50 errors. If thresholdType is 0, resolveThreshold must be greater than the critical threshold, otherwise, it must be less than the critical threshold.

owner (string)

The ID of the team or user that owns the rule.

monitorType (integer)

Monitor type represents whether the alert rule is actively being monitored or is monitored given a specific activation condition.

activationCondition (integer)

Optional int that represents a trigger condition for when to start monitoring

Scopes

• alert_rule:write
• alerts:write
• org:admin
• org:write