Create, list, update, pause, resume, and delete alert rules from the SDK across TypeScript, Python, Java, and Go.

Alerts

Alert rules keep an eye on a metric — latency, cost, tokens, error count, or an evaluation score — over your traces or sessions and send you a notification when the metric crosses a threshold.

Setup

Put your public and secret keys in your environment, then create one client and reuse it for every call on this page.

import { AISDK } from '@browserstack/ai-sdk';

const publicKey = process.env.AISDK_PUBLIC_KEY!;
const secretKey = process.env.AISDK_SECRET_KEY!;

const client = new AISDK({
  publicKey,
  secretKey,
});

import { AISDK } from '@browserstack/ai-sdk';const publicKey = process.env.AISDK_PUBLIC_KEY!;const secretKey = process.env.AISDK_SECRET_KEY!;const client = new AISDK({  publicKey,  secretKey,});

Create an alert

const alert = await client.alert.create({
  name,
  description: 'all-fields alert',
  scope: 'TRACE',
  aggregation: 'AVG',
  metric: 'latency',
  operator: 'GT',
  threshold: 750,
  unit: 'ms',
  windowMinutes: 5,
  cooldownMinutes: 10,
  environments: ['default'],
  notifications: [
    { channel: 'webhook', enabled: true, config: { url: 'https://example.com/sdk-test-webhook' } },
  ],
});

const alert = await client.alert.create({  name,  description: 'all-fields alert',  scope: 'TRACE',  aggregation: 'AVG',  metric: 'latency',  operator: 'GT',  threshold: 750,  unit: 'ms',  windowMinutes: 5,  cooldownMinutes: 10,  environments: ['default'],  notifications: [    { channel: 'webhook', enabled: true, config: { url: 'https://example.com/sdk-test-webhook' } },  ],});

The response includes everything the server saved — defaults it filled in for you, and the alert's id, which you'll use for every follow-up call.

Creates a new alert in your project. The server validates the window size, metric, environments, filter columns, and each notification target before saving.

Param	Type	Required	Description
`name`	`string`	`true`	A name for the alert. 1–255 characters.
`description`	`string \| null`	`false`	Optional free-form description. Up to 500 characters.
`scope`	`'TRACE' \| 'SESSION'` "TRACE" \| "SESSION"	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`aggregation`	`string` "AVG" \| "MIN" \| "MAX" \| "P50" \| "P95" \| "P99" \| "SUM" \| "COUNT"	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`metric`	`string`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`operator`	`string` "GT" \| "LT" \| "GTE" \| "LTE"	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`threshold`	`number`	`false`	The value the metric is compared against.
`unit`	`string \| null`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`windowMinutes`	`number` 5 \| 10 \| 15 \| 30 \| 60 \| 360 \| 720 \| 1440 \| 4320 \| 10080	`true`	How far back to look when aggregating the metric.
`cooldownMinutes`	`number`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`environments`	`string[]`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`notifications`	`NotificationTarget[]`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Record<string, unknown> \| null`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`name`	`str`	`true`	A name for the alert. 1–255 characters.
`description`	`Optional[str]`	`false`	Optional free-form description. Up to 500 characters.
`scope`	`Optional[AlertConfigScope]` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`aggregation`	`Optional[AlertConfigAggregation]` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`metric`	`Optional[object]`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`operator`	`Optional[AlertConfigOperator]` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`threshold`	`Optional[float]`	`false`	The value the metric is compared against.
`unit`	`Optional[str]`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`window_minutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`true`	How far back to look when aggregating the metric.
`cooldown_minutes`	`Optional[int]`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`environments`	`Optional[list[str]]`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`notifications`	`list[NotificationTargetInput]`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Optional[dict[str, object]]`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`name`	`String`	`true`	A name for the alert. 1–255 characters.
`description`	`String`	`false`	Optional free-form description. Up to 500 characters.
`scope`	`AlertConfigScope` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`aggregation`	`AlertConfigAggregation` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`metric`	`String`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`operator`	`AlertConfigOperator` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`threshold`	`Double`	`false`	The value the metric is compared against.
`unit`	`String`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`windowMinutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`true`	How far back to look when aggregating the metric.
`cooldownMinutes`	`Integer`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`environments`	`List<String>`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`notifications`	`List<NotificationTarget>`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Map<String, Object>`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`Name`	`string`	`true`	A name for the alert. 1–255 characters.
`Description`	`*string`	`false`	Optional free-form description. Up to 500 characters.
`Scope`	`*AlertConfigScope` AlertConfigScopeTRACE, AlertConfigScopeSESSION	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`Aggregation`	`*AlertConfigAggregation` AlertConfigAggregationAVG, AlertConfigAggregationMIN, AlertConfigAggregationMAX, AlertConfigAggregationP50, AlertConfigAggregationP95, AlertConfigAggregationP99, AlertConfigAggregationSUM, AlertConfigAggregationCOUNT	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`Metric`	`*string`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`Operator`	`*AlertConfigOperator` AlertConfigOperatorGT, AlertConfigOperatorLT, AlertConfigOperatorGTE, AlertConfigOperatorLTE	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`Threshold`	`*float64`	`false`	The value the metric is compared against.
`Unit`	`*string`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`WindowMinutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutesM_5, AlertConfigWindowMinutesM_10, AlertConfigWindowMinutesM_15, AlertConfigWindowMinutesM_30, AlertConfigWindowMinutesM_60, AlertConfigWindowMinutesM_360, AlertConfigWindowMinutesM_720, AlertConfigWindowMinutesM_1440, AlertConfigWindowMinutesM_4320, AlertConfigWindowMinutesM_10080	`true`	How far back to look when aggregating the metric.
`CooldownMinutes`	`*int`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`Environments`	`*[]string`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`Notifications`	`[]NotificationTarget`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`Notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`Notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`Notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`Filter`	`map[string]interface{}`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

List alerts

const res = await client.alert.list();

const res = await client.alert.list();

meta contains the pagination fields (page, limit, totalItems, totalPages). Asking for a page past the last one returns an empty data array — not an error.

Lists the alerts in your project, paginated. You can narrow the results by searching the name, or by filtering on status, scope, or metric.

Param	Type	Required	Description
`page`	`number`	`false`	1-indexed page number (default 1) Default: `1`
`limit`	`number`	`false`	Page size, max 100 (default 50) Default: `50`
`search`	`string`	`false`	Substring match on alert name (case-insensitive)
`status`	`'active' \| 'paused'` "active" \| "paused"	`false`	Filter by status — "active" or "paused"
`scope`	`'TRACE' \| 'SESSION'` "TRACE" \| "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`metric`	`string`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Param	Type	Required	Description
`page`	`Optional[int]`	`false`	1-indexed page number (default 1) Default: `1`
`limit`	`Optional[int]`	`false`	Page size, max 100 (default 50) Default: `50`
`search`	`Optional[str]`	`false`	Substring match on alert name (case-insensitive)
`status`	`Optional[str]` "active", "paused"	`false`	Filter by status — "active" or "paused"
`scope`	`Optional[str]` "TRACE", "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`metric`	`Optional[str]`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Param	Type	Required	Description
`page`	`Integer`	`false`	1-indexed page number (default 1) Default: `1`
`limit`	`Integer`	`false`	Page size, max 100 (default 50) Default: `50`
`search`	`String`	`false`	Substring match on alert name (case-insensitive)
`status`	`String` "active", "paused"	`false`	Filter by status — "active" or "paused"
`scope`	`String` "TRACE", "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`metric`	`String`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Param	Type	Required	Description
`Page`	`*int`	`false`	1-indexed page number (default 1) Default: `1`
`Limit`	`*int`	`false`	Page size, max 100 (default 50) Default: `50`
`Search`	`*string`	`false`	Substring match on alert name (case-insensitive)
`Status`	`*string` "active", "paused"	`false`	Filter by status — "active" or "paused"
`Scope`	`*string` "TRACE", "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`Metric`	`*string`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Get an alert by id

const fetched = await client.alert.get(alertId);

const fetched = await client.alert.get(alertId);

Get one alert by id

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Update an alert

Only the fields you send are updated — everything else stays the way it was. Handy for tweaking a threshold without rewriting the whole request.

const updated = await client.alert.update(alertId, {
  threshold: 999,
  description: 'updated description',
});

const updated = await client.alert.update(alertId, {  threshold: 999,  description: 'updated description',});

Updates the alert. Only the fields you send are changed — anything you leave out stays the same. Pass `description: null` to clear the description.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id
`name`	`string`	`false`	New name. 1–255 characters.
`description`	`string \| null`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`scope`	`'TRACE' \| 'SESSION'` "TRACE" \| "SESSION"	`false`	Whether the alert watches trace metrics or session metrics.
`aggregation`	`string` "AVG" \| "MIN" \| "MAX" \| "P50" \| "P95" \| "P99" \| "SUM" \| "COUNT"	`false`	New aggregation over the window.
`metric`	`string`	`false`	New metric — a built-in metric or `score:<name>`.
`operator`	`string` "GT" \| "LT" \| "GTE" \| "LTE"	`false`	New comparison between the aggregated metric and the threshold.
`threshold`	`number`	`false`	New threshold.
`unit`	`string \| null`	`false`	New display unit. Pass `null` to clear.
`windowMinutes`	`number` 5 \| 10 \| 15 \| 30 \| 60 \| 360 \| 720 \| 1440 \| 4320 \| 10080	`false`	New look-back window in minutes.
`cooldownMinutes`	`number`	`false`	New cooldown between fires.
`environments`	`string[]`	`false`	New environments. Empty means evaluate every environment.
`notifications`	`NotificationTarget[]`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Record<string, unknown> \| null`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id
`name`	`Optional[str]`	`false`	New name. 1–255 characters.
`description`	`Optional[str]`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`scope`	`Optional[AlertConfigScope]` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics.
`aggregation`	`Optional[AlertConfigAggregation]` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	New aggregation over the window.
`metric`	`Optional[object]`	`false`	New metric — a built-in metric or `score:<name>`.
`operator`	`Optional[AlertConfigOperator]` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	New comparison between the aggregated metric and the threshold.
`threshold`	`Optional[float]`	`false`	New threshold.
`unit`	`Optional[str]`	`false`	New display unit. Pass `null` to clear.
`window_minutes`	`Optional[AlertConfigWindowMinutes]` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`false`	New look-back window in minutes.
`cooldown_minutes`	`Optional[int]`	`false`	New cooldown between fires.
`environments`	`Optional[list[str]]`	`false`	New environments. Empty means evaluate every environment.
`notifications`	`Optional[list[NotificationTargetInput]]`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Optional[dict[str, object]]`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id
`name`	`String`	`false`	New name. 1–255 characters.
`description`	`String`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`scope`	`AlertConfigScope` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics.
`aggregation`	`AlertConfigAggregation` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	New aggregation over the window.
`metric`	`String`	`false`	New metric — a built-in metric or `score:<name>`.
`operator`	`AlertConfigOperator` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	New comparison between the aggregated metric and the threshold.
`threshold`	`Double`	`false`	New threshold.
`unit`	`String`	`false`	New display unit. Pass `null` to clear.
`windowMinutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`false`	New look-back window in minutes.
`cooldownMinutes`	`Integer`	`false`	New cooldown between fires.
`environments`	`List<String>`	`false`	New environments. Empty means evaluate every environment.
`notifications`	`List<NotificationTarget>`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Map<String, Object>`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id
`Name`	`*string`	`false`	New name. 1–255 characters.
`Description`	`*string`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`Scope`	`*AlertConfigScope` AlertConfigScopeTRACE, AlertConfigScopeSESSION	`false`	Whether the alert watches trace metrics or session metrics.
`Aggregation`	`*AlertConfigAggregation` AlertConfigAggregationAVG, AlertConfigAggregationMIN, AlertConfigAggregationMAX, AlertConfigAggregationP50, AlertConfigAggregationP95, AlertConfigAggregationP99, AlertConfigAggregationSUM, AlertConfigAggregationCOUNT	`false`	New aggregation over the window.
`Metric`	`*string`	`false`	New metric — a built-in metric or `score:<name>`.
`Operator`	`*AlertConfigOperator` AlertConfigOperatorGT, AlertConfigOperatorLT, AlertConfigOperatorGTE, AlertConfigOperatorLTE	`false`	New comparison between the aggregated metric and the threshold.
`Threshold`	`*float64`	`false`	New threshold.
`Unit`	`*string`	`false`	New display unit. Pass `null` to clear.
`WindowMinutes`	`*AlertConfigWindowMinutes` AlertConfigWindowMinutesM_5, AlertConfigWindowMinutesM_10, AlertConfigWindowMinutesM_15, AlertConfigWindowMinutesM_30, AlertConfigWindowMinutesM_60, AlertConfigWindowMinutesM_360, AlertConfigWindowMinutesM_720, AlertConfigWindowMinutesM_1440, AlertConfigWindowMinutesM_4320, AlertConfigWindowMinutesM_10080	`false`	New look-back window in minutes.
`CooldownMinutes`	`*int`	`false`	New cooldown between fires.
`Environments`	`*[]string`	`false`	New environments. Empty means evaluate every environment.
`Notifications`	`*[]NotificationTarget`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`Notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`Notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`Notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`Filter`	`map[string]interface{}`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

pause() disables an alert without deleting it — useful during a maintenance window when you don't want false alarms. resume() turns it back on. Both are simple wrappers around the /toggle endpoint.

const paused = await client.alert.pause(alertId);

const paused = await client.alert.pause(alertId);

const resumed = await client.alert.resume(alertId);

const resumed = await client.alert.resume(alertId);

Pause an alert without deleting its config. Convenience wrapper for `toggleAlert(alertId, false)`.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Re-enable a previously-paused alert. Convenience wrapper for `toggleAlert(alertId, true)`.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Delete an alert

const result = await client.alert.delete(alert.id);

const result = await client.alert.delete(alert.id);

Calling get() on the same id afterwards returns 404.

Delete an alert

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Complete example

Every step above, stitched together into one block you can copy and adapt. Fill in alertId where a later step needs the id returned by create.

// 1. Set up the client
import { AISDK } from '@browserstack/ai-sdk';

const publicKey = process.env.AISDK_PUBLIC_KEY!;
const secretKey = process.env.AISDK_SECRET_KEY!;

const client = new AISDK({
  publicKey,
  secretKey,
});

// 2. Per-run variables
const name = 'High p95 latency on production traces';

// 3. Create an alert
const alert = await client.alert.create({
  name,
  description: 'all-fields alert',
  scope: 'TRACE',
  aggregation: 'AVG',
  metric: 'latency',
  operator: 'GT',
  threshold: 750,
  unit: 'ms',
  windowMinutes: 5,
  cooldownMinutes: 10,
  environments: ['default'],
  notifications: [
    { channel: 'webhook', enabled: true, config: { url: 'https://example.com/sdk-test-webhook' } },
  ],
});

// 4. Grab the id for later steps
const alertId = alert.id;

// 5. List alerts
const res = await client.alert.list();

// 6. Fetch it by id
const fetched = await client.alert.get(alertId);

// 7. Update the threshold
const updated = await client.alert.update(alertId, {
  threshold: 999,
  description: 'updated description',
});

// 8. Pause during maintenance
const paused = await client.alert.pause(alertId);

// 9. Resume when done
const resumed = await client.alert.resume(alertId);

// 10. Delete the alert
const result = await client.alert.delete(alert.id);

// 1. Set up the clientimport { AISDK } from '@browserstack/ai-sdk';const publicKey = process.env.AISDK_PUBLIC_KEY!;const secretKey = process.env.AISDK_SECRET_KEY!;const client = new AISDK({  publicKey,  secretKey,});// 2. Per-run variablesconst name = 'High p95 latency on production traces';// 3. Create an alertconst alert = await client.alert.create({  name,  description: 'all-fields alert',  scope: 'TRACE',  aggregation: 'AVG',  metric: 'latency',  operator: 'GT',  threshold: 750,  unit: 'ms',  windowMinutes: 5,  cooldownMinutes: 10,  environments: ['default'],  notifications: [    { channel: 'webhook', enabled: true, config: { url: 'https://example.com/sdk-test-webhook' } },  ],});// 4. Grab the id for later stepsconst alertId = alert.id;// 5. List alertsconst res = await client.alert.list();// 6. Fetch it by idconst fetched = await client.alert.get(alertId);// 7. Update the thresholdconst updated = await client.alert.update(alertId, {  threshold: 999,  description: 'updated description',});// 8. Pause during maintenanceconst paused = await client.alert.pause(alertId);// 9. Resume when doneconst resumed = await client.alert.resume(alertId);// 10. Delete the alertconst result = await client.alert.delete(alert.id);

Setup

Put your public and secret keys in your environment, then create one client and reuse it for every call on this page.

from browserstack_ai_sdk import AISDK

client = AISDK(
    public_key=os.environ["AISDK_PUBLIC_KEY"],
    secret_key=os.environ["AISDK_SECRET_KEY"],
)

from browserstack_ai_sdk import AISDKclient = AISDK(    public_key=os.environ["AISDK_PUBLIC_KEY"],    secret_key=os.environ["AISDK_SECRET_KEY"],)

Create an alert

alert = client.alert.create(
    name=name,
    scope="TRACE",
    aggregation="AVG",
    metric="latency",
    operator="GT",
    threshold=750,
    window_minutes=5,
    cooldown_minutes=10,
    environments=["default"],
    notifications=[
        {
            "channel": "webhook",
            "enabled": True,
            "config": {"url": "https://example.com/alerts/webhook"},
        },
    ],
    description="all-fields alert",
    unit="ms",
)

alert = client.alert.create(    name=name,    scope="TRACE",    aggregation="AVG",    metric="latency",    operator="GT",    threshold=750,    window_minutes=5,    cooldown_minutes=10,    environments=["default"],    notifications=[        {            "channel": "webhook",            "enabled": True,            "config": {"url": "https://example.com/alerts/webhook"},        },    ],    description="all-fields alert",    unit="ms",)

The response includes everything the server saved — defaults it filled in for you, and the alert's id, which you'll use for every follow-up call.

Creates a new alert in your project. The server validates the window size, metric, environments, filter columns, and each notification target before saving.

Param	Type	Required	Description
`name`	`string`	`true`	A name for the alert. 1–255 characters.
`description`	`string \| null`	`false`	Optional free-form description. Up to 500 characters.
`scope`	`'TRACE' \| 'SESSION'` "TRACE" \| "SESSION"	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`aggregation`	`string` "AVG" \| "MIN" \| "MAX" \| "P50" \| "P95" \| "P99" \| "SUM" \| "COUNT"	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`metric`	`string`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`operator`	`string` "GT" \| "LT" \| "GTE" \| "LTE"	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`threshold`	`number`	`false`	The value the metric is compared against.
`unit`	`string \| null`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`windowMinutes`	`number` 5 \| 10 \| 15 \| 30 \| 60 \| 360 \| 720 \| 1440 \| 4320 \| 10080	`true`	How far back to look when aggregating the metric.
`cooldownMinutes`	`number`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`environments`	`string[]`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`notifications`	`NotificationTarget[]`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Record<string, unknown> \| null`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`name`	`str`	`true`	A name for the alert. 1–255 characters.
`description`	`Optional[str]`	`false`	Optional free-form description. Up to 500 characters.
`scope`	`Optional[AlertConfigScope]` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`aggregation`	`Optional[AlertConfigAggregation]` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`metric`	`Optional[object]`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`operator`	`Optional[AlertConfigOperator]` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`threshold`	`Optional[float]`	`false`	The value the metric is compared against.
`unit`	`Optional[str]`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`window_minutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`true`	How far back to look when aggregating the metric.
`cooldown_minutes`	`Optional[int]`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`environments`	`Optional[list[str]]`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`notifications`	`list[NotificationTargetInput]`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Optional[dict[str, object]]`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`name`	`String`	`true`	A name for the alert. 1–255 characters.
`description`	`String`	`false`	Optional free-form description. Up to 500 characters.
`scope`	`AlertConfigScope` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`aggregation`	`AlertConfigAggregation` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`metric`	`String`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`operator`	`AlertConfigOperator` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`threshold`	`Double`	`false`	The value the metric is compared against.
`unit`	`String`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`windowMinutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`true`	How far back to look when aggregating the metric.
`cooldownMinutes`	`Integer`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`environments`	`List<String>`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`notifications`	`List<NotificationTarget>`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Map<String, Object>`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`Name`	`string`	`true`	A name for the alert. 1–255 characters.
`Description`	`*string`	`false`	Optional free-form description. Up to 500 characters.
`Scope`	`*AlertConfigScope` AlertConfigScopeTRACE, AlertConfigScopeSESSION	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`Aggregation`	`*AlertConfigAggregation` AlertConfigAggregationAVG, AlertConfigAggregationMIN, AlertConfigAggregationMAX, AlertConfigAggregationP50, AlertConfigAggregationP95, AlertConfigAggregationP99, AlertConfigAggregationSUM, AlertConfigAggregationCOUNT	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`Metric`	`*string`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`Operator`	`*AlertConfigOperator` AlertConfigOperatorGT, AlertConfigOperatorLT, AlertConfigOperatorGTE, AlertConfigOperatorLTE	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`Threshold`	`*float64`	`false`	The value the metric is compared against.
`Unit`	`*string`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`WindowMinutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutesM_5, AlertConfigWindowMinutesM_10, AlertConfigWindowMinutesM_15, AlertConfigWindowMinutesM_30, AlertConfigWindowMinutesM_60, AlertConfigWindowMinutesM_360, AlertConfigWindowMinutesM_720, AlertConfigWindowMinutesM_1440, AlertConfigWindowMinutesM_4320, AlertConfigWindowMinutesM_10080	`true`	How far back to look when aggregating the metric.
`CooldownMinutes`	`*int`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`Environments`	`*[]string`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`Notifications`	`[]NotificationTarget`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`Notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`Notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`Notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`Filter`	`map[string]interface{}`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

List alerts

res = client.alert.list(page=1, limit=50)
data = res.data
meta = res.meta

res = client.alert.list(page=1, limit=50)data = res.datameta = res.meta

meta contains the pagination fields (page, limit, total_items, total_pages). Asking for a page past the last one returns an empty data array — not an error.

Lists the alerts in your project, paginated. You can narrow the results by searching the name, or by filtering on status, scope, or metric.

Param	Type	Required	Description
`page`	`number`	`false`	1-indexed page number (default 1) Default: `1`
`limit`	`number`	`false`	Page size, max 100 (default 50) Default: `50`
`search`	`string`	`false`	Substring match on alert name (case-insensitive)
`status`	`'active' \| 'paused'` "active" \| "paused"	`false`	Filter by status — "active" or "paused"
`scope`	`'TRACE' \| 'SESSION'` "TRACE" \| "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`metric`	`string`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Param	Type	Required	Description
`page`	`Optional[int]`	`false`	1-indexed page number (default 1) Default: `1`
`limit`	`Optional[int]`	`false`	Page size, max 100 (default 50) Default: `50`
`search`	`Optional[str]`	`false`	Substring match on alert name (case-insensitive)
`status`	`Optional[str]` "active", "paused"	`false`	Filter by status — "active" or "paused"
`scope`	`Optional[str]` "TRACE", "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`metric`	`Optional[str]`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Param	Type	Required	Description
`page`	`Integer`	`false`	1-indexed page number (default 1) Default: `1`
`limit`	`Integer`	`false`	Page size, max 100 (default 50) Default: `50`
`search`	`String`	`false`	Substring match on alert name (case-insensitive)
`status`	`String` "active", "paused"	`false`	Filter by status — "active" or "paused"
`scope`	`String` "TRACE", "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`metric`	`String`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Param	Type	Required	Description
`Page`	`*int`	`false`	1-indexed page number (default 1) Default: `1`
`Limit`	`*int`	`false`	Page size, max 100 (default 50) Default: `50`
`Search`	`*string`	`false`	Substring match on alert name (case-insensitive)
`Status`	`*string` "active", "paused"	`false`	Filter by status — "active" or "paused"
`Scope`	`*string` "TRACE", "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`Metric`	`*string`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Get an alert by id

fetched = client.alert.get(alert_id)

fetched = client.alert.get(alert_id)

Get one alert by id

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Update an alert

Only the fields you send are updated — everything else stays the way it was. Handy for tweaking a threshold without rewriting the whole request.

updated = client.alert.update(
    alert_id,
    threshold=999,
    description="updated description",
)

updated = client.alert.update(    alert_id,    threshold=999,    description="updated description",)

Updates the alert. Only the fields you send are changed — anything you leave out stays the same. Pass `description: null` to clear the description.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id
`name`	`string`	`false`	New name. 1–255 characters.
`description`	`string \| null`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`scope`	`'TRACE' \| 'SESSION'` "TRACE" \| "SESSION"	`false`	Whether the alert watches trace metrics or session metrics.
`aggregation`	`string` "AVG" \| "MIN" \| "MAX" \| "P50" \| "P95" \| "P99" \| "SUM" \| "COUNT"	`false`	New aggregation over the window.
`metric`	`string`	`false`	New metric — a built-in metric or `score:<name>`.
`operator`	`string` "GT" \| "LT" \| "GTE" \| "LTE"	`false`	New comparison between the aggregated metric and the threshold.
`threshold`	`number`	`false`	New threshold.
`unit`	`string \| null`	`false`	New display unit. Pass `null` to clear.
`windowMinutes`	`number` 5 \| 10 \| 15 \| 30 \| 60 \| 360 \| 720 \| 1440 \| 4320 \| 10080	`false`	New look-back window in minutes.
`cooldownMinutes`	`number`	`false`	New cooldown between fires.
`environments`	`string[]`	`false`	New environments. Empty means evaluate every environment.
`notifications`	`NotificationTarget[]`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Record<string, unknown> \| null`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id
`name`	`Optional[str]`	`false`	New name. 1–255 characters.
`description`	`Optional[str]`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`scope`	`Optional[AlertConfigScope]` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics.
`aggregation`	`Optional[AlertConfigAggregation]` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	New aggregation over the window.
`metric`	`Optional[object]`	`false`	New metric — a built-in metric or `score:<name>`.
`operator`	`Optional[AlertConfigOperator]` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	New comparison between the aggregated metric and the threshold.
`threshold`	`Optional[float]`	`false`	New threshold.
`unit`	`Optional[str]`	`false`	New display unit. Pass `null` to clear.
`window_minutes`	`Optional[AlertConfigWindowMinutes]` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`false`	New look-back window in minutes.
`cooldown_minutes`	`Optional[int]`	`false`	New cooldown between fires.
`environments`	`Optional[list[str]]`	`false`	New environments. Empty means evaluate every environment.
`notifications`	`Optional[list[NotificationTargetInput]]`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Optional[dict[str, object]]`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id
`name`	`String`	`false`	New name. 1–255 characters.
`description`	`String`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`scope`	`AlertConfigScope` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics.
`aggregation`	`AlertConfigAggregation` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	New aggregation over the window.
`metric`	`String`	`false`	New metric — a built-in metric or `score:<name>`.
`operator`	`AlertConfigOperator` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	New comparison between the aggregated metric and the threshold.
`threshold`	`Double`	`false`	New threshold.
`unit`	`String`	`false`	New display unit. Pass `null` to clear.
`windowMinutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`false`	New look-back window in minutes.
`cooldownMinutes`	`Integer`	`false`	New cooldown between fires.
`environments`	`List<String>`	`false`	New environments. Empty means evaluate every environment.
`notifications`	`List<NotificationTarget>`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Map<String, Object>`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id
`Name`	`*string`	`false`	New name. 1–255 characters.
`Description`	`*string`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`Scope`	`*AlertConfigScope` AlertConfigScopeTRACE, AlertConfigScopeSESSION	`false`	Whether the alert watches trace metrics or session metrics.
`Aggregation`	`*AlertConfigAggregation` AlertConfigAggregationAVG, AlertConfigAggregationMIN, AlertConfigAggregationMAX, AlertConfigAggregationP50, AlertConfigAggregationP95, AlertConfigAggregationP99, AlertConfigAggregationSUM, AlertConfigAggregationCOUNT	`false`	New aggregation over the window.
`Metric`	`*string`	`false`	New metric — a built-in metric or `score:<name>`.
`Operator`	`*AlertConfigOperator` AlertConfigOperatorGT, AlertConfigOperatorLT, AlertConfigOperatorGTE, AlertConfigOperatorLTE	`false`	New comparison between the aggregated metric and the threshold.
`Threshold`	`*float64`	`false`	New threshold.
`Unit`	`*string`	`false`	New display unit. Pass `null` to clear.
`WindowMinutes`	`*AlertConfigWindowMinutes` AlertConfigWindowMinutesM_5, AlertConfigWindowMinutesM_10, AlertConfigWindowMinutesM_15, AlertConfigWindowMinutesM_30, AlertConfigWindowMinutesM_60, AlertConfigWindowMinutesM_360, AlertConfigWindowMinutesM_720, AlertConfigWindowMinutesM_1440, AlertConfigWindowMinutesM_4320, AlertConfigWindowMinutesM_10080	`false`	New look-back window in minutes.
`CooldownMinutes`	`*int`	`false`	New cooldown between fires.
`Environments`	`*[]string`	`false`	New environments. Empty means evaluate every environment.
`Notifications`	`*[]NotificationTarget`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`Notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`Notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`Notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`Filter`	`map[string]interface{}`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Pause and resume

paused = client.alert.pause(alert_id)

paused = client.alert.pause(alert_id)

resumed = client.alert.resume(alert_id)

resumed = client.alert.resume(alert_id)

Pause an alert without deleting its config. Convenience wrapper for `toggleAlert(alertId, false)`.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Re-enable a previously-paused alert. Convenience wrapper for `toggleAlert(alertId, true)`.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Delete an alert

result = client.alert.delete(alert_id)

result = client.alert.delete(alert_id)

Calling get() on the same id afterwards returns 404.

Delete an alert

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Complete example

Every step above, stitched together into one block you can copy and adapt. Fill in alert_id where a later step needs the id returned by create.

# 1. Set up the client
from browserstack_ai_sdk import AISDK

client = AISDK(
    public_key=os.environ["AISDK_PUBLIC_KEY"],
    secret_key=os.environ["AISDK_SECRET_KEY"],
)

# 2. Per-run variables
name = "High p95 latency on production traces"

# 3. Create an alert
alert = client.alert.create(
    name=name,
    scope="TRACE",
    aggregation="AVG",
    metric="latency",
    operator="GT",
    threshold=750,
    window_minutes=5,
    cooldown_minutes=10,
    environments=["default"],
    notifications=[
        {
            "channel": "webhook",
            "enabled": True,
            "config": {"url": "https://example.com/alerts/webhook"},
        },
    ],
    description="all-fields alert",
    unit="ms",
)

# 4. Grab the id for later steps
alert_id = alert.id

# 5. List alerts
res = client.alert.list(page=1, limit=50)
data = res.data
meta = res.meta

# 6. Fetch it by id
fetched = client.alert.get(alert_id)

# 7. Update the threshold
updated = client.alert.update(
    alert_id,
    threshold=999,
    description="updated description",
)

# 8. Pause during maintenance
paused = client.alert.pause(alert_id)

# 9. Resume when done
resumed = client.alert.resume(alert_id)

# 10. Delete the alert
result = client.alert.delete(alert_id)

# 1. Set up the clientfrom browserstack_ai_sdk import AISDKclient = AISDK(    public_key=os.environ["AISDK_PUBLIC_KEY"],    secret_key=os.environ["AISDK_SECRET_KEY"],)# 2. Per-run variablesname = "High p95 latency on production traces"# 3. Create an alertalert = client.alert.create(    name=name,    scope="TRACE",    aggregation="AVG",    metric="latency",    operator="GT",    threshold=750,    window_minutes=5,    cooldown_minutes=10,    environments=["default"],    notifications=[        {            "channel": "webhook",            "enabled": True,            "config": {"url": "https://example.com/alerts/webhook"},        },    ],    description="all-fields alert",    unit="ms",)# 4. Grab the id for later stepsalert_id = alert.id# 5. List alertsres = client.alert.list(page=1, limit=50)data = res.datameta = res.meta# 6. Fetch it by idfetched = client.alert.get(alert_id)# 7. Update the thresholdupdated = client.alert.update(    alert_id,    threshold=999,    description="updated description",)# 8. Pause during maintenancepaused = client.alert.pause(alert_id)# 9. Resume when doneresumed = client.alert.resume(alert_id)# 10. Delete the alertresult = client.alert.delete(alert_id)

Setup

Put your public and secret keys in your environment, then create one SDK instance and reuse it for every call on this page.

import com.browserstack.aisdk.AISDK;
import com.browserstack.aisdk.clients.alert.Alert;
import com.browserstack.aisdk.clients.alert.AlertConfig;
import com.browserstack.aisdk.clients.alert.AlertConfigAggregation;
import com.browserstack.aisdk.clients.alert.AlertConfigOperator;
import com.browserstack.aisdk.clients.alert.AlertConfigScope;
import com.browserstack.aisdk.clients.alert.AlertConfigWindowMinutes;
import com.browserstack.aisdk.clients.alert.CreateAlertBody;
import com.browserstack.aisdk.clients.alert.DeleteAlertResponse;
import com.browserstack.aisdk.clients.alert.ListAlertsParams;
import com.browserstack.aisdk.clients.alert.ListAlertsResponse;
import com.browserstack.aisdk.clients.alert.NotificationTarget;
import com.browserstack.aisdk.clients.alert.NotificationTargetChannel;
import com.browserstack.aisdk.clients.alert.PaginationMeta;
import com.browserstack.aisdk.clients.alert.UpdateAlertBody;

import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

AISDK sdk = AISDK.builder()
    .publicKey(System.getenv("AISDK_PUBLIC_KEY"))
    .secretKey(System.getenv("AISDK_SECRET_KEY"))
    .build();
Alert alerts = sdk.alert();

import com.browserstack.aisdk.AISDK;import com.browserstack.aisdk.clients.alert.Alert;import com.browserstack.aisdk.clients.alert.AlertConfig;import com.browserstack.aisdk.clients.alert.AlertConfigAggregation;import com.browserstack.aisdk.clients.alert.AlertConfigOperator;import com.browserstack.aisdk.clients.alert.AlertConfigScope;import com.browserstack.aisdk.clients.alert.AlertConfigWindowMinutes;import com.browserstack.aisdk.clients.alert.CreateAlertBody;import com.browserstack.aisdk.clients.alert.DeleteAlertResponse;import com.browserstack.aisdk.clients.alert.ListAlertsParams;import com.browserstack.aisdk.clients.alert.ListAlertsResponse;import com.browserstack.aisdk.clients.alert.NotificationTarget;import com.browserstack.aisdk.clients.alert.NotificationTargetChannel;import com.browserstack.aisdk.clients.alert.PaginationMeta;import com.browserstack.aisdk.clients.alert.UpdateAlertBody;import java.util.Collections;import java.util.HashMap;import java.util.List;import java.util.Map;AISDK sdk = AISDK.builder()    .publicKey(System.getenv("AISDK_PUBLIC_KEY"))    .secretKey(System.getenv("AISDK_SECRET_KEY"))    .build();Alert alerts = sdk.alert();

Create an alert

NotificationTarget webhook = new NotificationTarget();
webhook.channel = NotificationTargetChannel.webhook;
webhook.enabled = true;
Map<String, Object> webhookConfig = new HashMap<>();
webhookConfig.put("url", "https://example.com/sdk-test-webhook");
webhook.config = webhookConfig;

CreateAlertBody body = new CreateAlertBody();
body.name = "High p95 latency on production traces";
body.description = "Notify on-call when average trace latency exceeds 750 ms.";
body.scope = AlertConfigScope.TRACE;
body.aggregation = AlertConfigAggregation.AVG;
body.metric = "latency";
body.operator = AlertConfigOperator.GT;
body.threshold = 750.0;
body.windowMinutes = AlertConfigWindowMinutes.M_5;
body.cooldownMinutes = 10;
body.environments = Collections.singletonList("default");
body.notifications = Collections.singletonList(webhook);

AlertConfig alert = client.create(body);

NotificationTarget webhook = new NotificationTarget();webhook.channel = NotificationTargetChannel.webhook;webhook.enabled = true;Map<String, Object> webhookConfig = new HashMap<>();webhookConfig.put("url", "https://example.com/sdk-test-webhook");webhook.config = webhookConfig;CreateAlertBody body = new CreateAlertBody();body.name = "High p95 latency on production traces";body.description = "Notify on-call when average trace latency exceeds 750 ms.";body.scope = AlertConfigScope.TRACE;body.aggregation = AlertConfigAggregation.AVG;body.metric = "latency";body.operator = AlertConfigOperator.GT;body.threshold = 750.0;body.windowMinutes = AlertConfigWindowMinutes.M_5;body.cooldownMinutes = 10;body.environments = Collections.singletonList("default");body.notifications = Collections.singletonList(webhook);AlertConfig alert = client.create(body);

The response includes everything the server saved — defaults it filled in for you, and the alert's id, which you'll use for every follow-up call.

Creates a new alert in your project. The server validates the window size, metric, environments, filter columns, and each notification target before saving.

Param	Type	Required	Description
`name`	`string`	`true`	A name for the alert. 1–255 characters.
`description`	`string \| null`	`false`	Optional free-form description. Up to 500 characters.
`scope`	`'TRACE' \| 'SESSION'` "TRACE" \| "SESSION"	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`aggregation`	`string` "AVG" \| "MIN" \| "MAX" \| "P50" \| "P95" \| "P99" \| "SUM" \| "COUNT"	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`metric`	`string`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`operator`	`string` "GT" \| "LT" \| "GTE" \| "LTE"	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`threshold`	`number`	`false`	The value the metric is compared against.
`unit`	`string \| null`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`windowMinutes`	`number` 5 \| 10 \| 15 \| 30 \| 60 \| 360 \| 720 \| 1440 \| 4320 \| 10080	`true`	How far back to look when aggregating the metric.
`cooldownMinutes`	`number`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`environments`	`string[]`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`notifications`	`NotificationTarget[]`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Record<string, unknown> \| null`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`name`	`str`	`true`	A name for the alert. 1–255 characters.
`description`	`Optional[str]`	`false`	Optional free-form description. Up to 500 characters.
`scope`	`Optional[AlertConfigScope]` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`aggregation`	`Optional[AlertConfigAggregation]` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`metric`	`Optional[object]`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`operator`	`Optional[AlertConfigOperator]` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`threshold`	`Optional[float]`	`false`	The value the metric is compared against.
`unit`	`Optional[str]`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`window_minutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`true`	How far back to look when aggregating the metric.
`cooldown_minutes`	`Optional[int]`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`environments`	`Optional[list[str]]`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`notifications`	`list[NotificationTargetInput]`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Optional[dict[str, object]]`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`name`	`String`	`true`	A name for the alert. 1–255 characters.
`description`	`String`	`false`	Optional free-form description. Up to 500 characters.
`scope`	`AlertConfigScope` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`aggregation`	`AlertConfigAggregation` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`metric`	`String`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`operator`	`AlertConfigOperator` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`threshold`	`Double`	`false`	The value the metric is compared against.
`unit`	`String`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`windowMinutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`true`	How far back to look when aggregating the metric.
`cooldownMinutes`	`Integer`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`environments`	`List<String>`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`notifications`	`List<NotificationTarget>`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Map<String, Object>`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`Name`	`string`	`true`	A name for the alert. 1–255 characters.
`Description`	`*string`	`false`	Optional free-form description. Up to 500 characters.
`Scope`	`*AlertConfigScope` AlertConfigScopeTRACE, AlertConfigScopeSESSION	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`Aggregation`	`*AlertConfigAggregation` AlertConfigAggregationAVG, AlertConfigAggregationMIN, AlertConfigAggregationMAX, AlertConfigAggregationP50, AlertConfigAggregationP95, AlertConfigAggregationP99, AlertConfigAggregationSUM, AlertConfigAggregationCOUNT	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`Metric`	`*string`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`Operator`	`*AlertConfigOperator` AlertConfigOperatorGT, AlertConfigOperatorLT, AlertConfigOperatorGTE, AlertConfigOperatorLTE	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`Threshold`	`*float64`	`false`	The value the metric is compared against.
`Unit`	`*string`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`WindowMinutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutesM_5, AlertConfigWindowMinutesM_10, AlertConfigWindowMinutesM_15, AlertConfigWindowMinutesM_30, AlertConfigWindowMinutesM_60, AlertConfigWindowMinutesM_360, AlertConfigWindowMinutesM_720, AlertConfigWindowMinutesM_1440, AlertConfigWindowMinutesM_4320, AlertConfigWindowMinutesM_10080	`true`	How far back to look when aggregating the metric.
`CooldownMinutes`	`*int`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`Environments`	`*[]string`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`Notifications`	`[]NotificationTarget`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`Notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`Notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`Notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`Filter`	`map[string]interface{}`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

List alerts

ListAlertsParams params = new ListAlertsParams();
params.page = 1;
params.limit = 50;
ListAlertsResponse res = client.list(params);

ListAlertsParams params = new ListAlertsParams();params.page = 1;params.limit = 50;ListAlertsResponse res = client.list(params);

meta contains the pagination fields (page, limit, totalItems, totalPages). Asking for a page past the last one returns an empty data list — not an error.

Lists the alerts in your project, paginated. You can narrow the results by searching the name, or by filtering on status, scope, or metric.

Param	Type	Required	Description
`page`	`number`	`false`	1-indexed page number (default 1) Default: `1`
`limit`	`number`	`false`	Page size, max 100 (default 50) Default: `50`
`search`	`string`	`false`	Substring match on alert name (case-insensitive)
`status`	`'active' \| 'paused'` "active" \| "paused"	`false`	Filter by status — "active" or "paused"
`scope`	`'TRACE' \| 'SESSION'` "TRACE" \| "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`metric`	`string`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Param	Type	Required	Description
`page`	`Optional[int]`	`false`	1-indexed page number (default 1) Default: `1`
`limit`	`Optional[int]`	`false`	Page size, max 100 (default 50) Default: `50`
`search`	`Optional[str]`	`false`	Substring match on alert name (case-insensitive)
`status`	`Optional[str]` "active", "paused"	`false`	Filter by status — "active" or "paused"
`scope`	`Optional[str]` "TRACE", "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`metric`	`Optional[str]`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Param	Type	Required	Description
`page`	`Integer`	`false`	1-indexed page number (default 1) Default: `1`
`limit`	`Integer`	`false`	Page size, max 100 (default 50) Default: `50`
`search`	`String`	`false`	Substring match on alert name (case-insensitive)
`status`	`String` "active", "paused"	`false`	Filter by status — "active" or "paused"
`scope`	`String` "TRACE", "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`metric`	`String`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Param	Type	Required	Description
`Page`	`*int`	`false`	1-indexed page number (default 1) Default: `1`
`Limit`	`*int`	`false`	Page size, max 100 (default 50) Default: `50`
`Search`	`*string`	`false`	Substring match on alert name (case-insensitive)
`Status`	`*string` "active", "paused"	`false`	Filter by status — "active" or "paused"
`Scope`	`*string` "TRACE", "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`Metric`	`*string`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Get an alert by id

AlertConfig fetched = client.get(alertId);

AlertConfig fetched = client.get(alertId);

Get one alert by id

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Update an alert

Only the fields you send are updated — everything else stays the way it was. Handy for tweaking a threshold without rewriting the whole request.

UpdateAlertBody update = new UpdateAlertBody();
update.threshold = 999.0;
update.description = "updated description";
AlertConfig updated = client.update(alertId, update);

UpdateAlertBody update = new UpdateAlertBody();update.threshold = 999.0;update.description = "updated description";AlertConfig updated = client.update(alertId, update);

Updates the alert. Only the fields you send are changed — anything you leave out stays the same. Pass `description: null` to clear the description.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id
`name`	`string`	`false`	New name. 1–255 characters.
`description`	`string \| null`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`scope`	`'TRACE' \| 'SESSION'` "TRACE" \| "SESSION"	`false`	Whether the alert watches trace metrics or session metrics.
`aggregation`	`string` "AVG" \| "MIN" \| "MAX" \| "P50" \| "P95" \| "P99" \| "SUM" \| "COUNT"	`false`	New aggregation over the window.
`metric`	`string`	`false`	New metric — a built-in metric or `score:<name>`.
`operator`	`string` "GT" \| "LT" \| "GTE" \| "LTE"	`false`	New comparison between the aggregated metric and the threshold.
`threshold`	`number`	`false`	New threshold.
`unit`	`string \| null`	`false`	New display unit. Pass `null` to clear.
`windowMinutes`	`number` 5 \| 10 \| 15 \| 30 \| 60 \| 360 \| 720 \| 1440 \| 4320 \| 10080	`false`	New look-back window in minutes.
`cooldownMinutes`	`number`	`false`	New cooldown between fires.
`environments`	`string[]`	`false`	New environments. Empty means evaluate every environment.
`notifications`	`NotificationTarget[]`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Record<string, unknown> \| null`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id
`name`	`Optional[str]`	`false`	New name. 1–255 characters.
`description`	`Optional[str]`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`scope`	`Optional[AlertConfigScope]` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics.
`aggregation`	`Optional[AlertConfigAggregation]` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	New aggregation over the window.
`metric`	`Optional[object]`	`false`	New metric — a built-in metric or `score:<name>`.
`operator`	`Optional[AlertConfigOperator]` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	New comparison between the aggregated metric and the threshold.
`threshold`	`Optional[float]`	`false`	New threshold.
`unit`	`Optional[str]`	`false`	New display unit. Pass `null` to clear.
`window_minutes`	`Optional[AlertConfigWindowMinutes]` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`false`	New look-back window in minutes.
`cooldown_minutes`	`Optional[int]`	`false`	New cooldown between fires.
`environments`	`Optional[list[str]]`	`false`	New environments. Empty means evaluate every environment.
`notifications`	`Optional[list[NotificationTargetInput]]`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Optional[dict[str, object]]`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id
`name`	`String`	`false`	New name. 1–255 characters.
`description`	`String`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`scope`	`AlertConfigScope` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics.
`aggregation`	`AlertConfigAggregation` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	New aggregation over the window.
`metric`	`String`	`false`	New metric — a built-in metric or `score:<name>`.
`operator`	`AlertConfigOperator` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	New comparison between the aggregated metric and the threshold.
`threshold`	`Double`	`false`	New threshold.
`unit`	`String`	`false`	New display unit. Pass `null` to clear.
`windowMinutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`false`	New look-back window in minutes.
`cooldownMinutes`	`Integer`	`false`	New cooldown between fires.
`environments`	`List<String>`	`false`	New environments. Empty means evaluate every environment.
`notifications`	`List<NotificationTarget>`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Map<String, Object>`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id
`Name`	`*string`	`false`	New name. 1–255 characters.
`Description`	`*string`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`Scope`	`*AlertConfigScope` AlertConfigScopeTRACE, AlertConfigScopeSESSION	`false`	Whether the alert watches trace metrics or session metrics.
`Aggregation`	`*AlertConfigAggregation` AlertConfigAggregationAVG, AlertConfigAggregationMIN, AlertConfigAggregationMAX, AlertConfigAggregationP50, AlertConfigAggregationP95, AlertConfigAggregationP99, AlertConfigAggregationSUM, AlertConfigAggregationCOUNT	`false`	New aggregation over the window.
`Metric`	`*string`	`false`	New metric — a built-in metric or `score:<name>`.
`Operator`	`*AlertConfigOperator` AlertConfigOperatorGT, AlertConfigOperatorLT, AlertConfigOperatorGTE, AlertConfigOperatorLTE	`false`	New comparison between the aggregated metric and the threshold.
`Threshold`	`*float64`	`false`	New threshold.
`Unit`	`*string`	`false`	New display unit. Pass `null` to clear.
`WindowMinutes`	`*AlertConfigWindowMinutes` AlertConfigWindowMinutesM_5, AlertConfigWindowMinutesM_10, AlertConfigWindowMinutesM_15, AlertConfigWindowMinutesM_30, AlertConfigWindowMinutesM_60, AlertConfigWindowMinutesM_360, AlertConfigWindowMinutesM_720, AlertConfigWindowMinutesM_1440, AlertConfigWindowMinutesM_4320, AlertConfigWindowMinutesM_10080	`false`	New look-back window in minutes.
`CooldownMinutes`	`*int`	`false`	New cooldown between fires.
`Environments`	`*[]string`	`false`	New environments. Empty means evaluate every environment.
`Notifications`	`*[]NotificationTarget`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`Notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`Notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`Notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`Filter`	`map[string]interface{}`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Pause and resume

AlertConfig paused = client.pause(alertId);

AlertConfig paused = client.pause(alertId);

AlertConfig resumed = client.resume(alertId);

AlertConfig resumed = client.resume(alertId);

Pause an alert without deleting its config. Convenience wrapper for `toggleAlert(alertId, false)`.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Re-enable a previously-paused alert. Convenience wrapper for `toggleAlert(alertId, true)`.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Delete an alert

DeleteAlertResponse result = client.delete(alertId);

DeleteAlertResponse result = client.delete(alertId);

Calling get() on the same id afterwards throws (mapped from HTTP 404).

Delete an alert

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Complete example

Every step above, stitched together into one block you can copy and adapt. Fill in alertId where a later step needs the id returned by create.

// 1. Set up the SDK
import com.browserstack.aisdk.AISDK;
import com.browserstack.aisdk.clients.alert.Alert;
import com.browserstack.aisdk.clients.alert.AlertConfig;
import com.browserstack.aisdk.clients.alert.AlertConfigAggregation;
import com.browserstack.aisdk.clients.alert.AlertConfigOperator;
import com.browserstack.aisdk.clients.alert.AlertConfigScope;
import com.browserstack.aisdk.clients.alert.AlertConfigWindowMinutes;
import com.browserstack.aisdk.clients.alert.CreateAlertBody;
import com.browserstack.aisdk.clients.alert.DeleteAlertResponse;
import com.browserstack.aisdk.clients.alert.ListAlertsParams;
import com.browserstack.aisdk.clients.alert.ListAlertsResponse;
import com.browserstack.aisdk.clients.alert.NotificationTarget;
import com.browserstack.aisdk.clients.alert.NotificationTargetChannel;
import com.browserstack.aisdk.clients.alert.PaginationMeta;
import com.browserstack.aisdk.clients.alert.UpdateAlertBody;

import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

AISDK sdk = AISDK.builder()
    .publicKey(System.getenv("AISDK_PUBLIC_KEY"))
    .secretKey(System.getenv("AISDK_SECRET_KEY"))
    .build();
Alert alerts = sdk.alert();

// 2. Per-run variables
String name = "High p95 latency on production traces";

// 3. Create an alert
NotificationTarget webhook = new NotificationTarget();
webhook.channel = NotificationTargetChannel.webhook;
webhook.enabled = true;
Map<String, Object> webhookConfig = new HashMap<>();
webhookConfig.put("url", "https://example.com/sdk-test-webhook");
webhook.config = webhookConfig;

CreateAlertBody body = new CreateAlertBody();
body.name = "High p95 latency on production traces";
body.description = "Notify on-call when average trace latency exceeds 750 ms.";
body.scope = AlertConfigScope.TRACE;
body.aggregation = AlertConfigAggregation.AVG;
body.metric = "latency";
body.operator = AlertConfigOperator.GT;
body.threshold = 750.0;
body.windowMinutes = AlertConfigWindowMinutes.M_5;
body.cooldownMinutes = 10;
body.environments = Collections.singletonList("default");
body.notifications = Collections.singletonList(webhook);

AlertConfig alert = client.create(body);

// 4. Grab the id for later steps
String alertId = alert.id;

// 5. List alerts
ListAlertsParams params = new ListAlertsParams();
params.page = 1;
params.limit = 50;
ListAlertsResponse res = client.list(params);

// 6. Fetch it by id
AlertConfig fetched = client.get(alertId);

// 7. Update the threshold
UpdateAlertBody update = new UpdateAlertBody();
update.threshold = 999.0;
update.description = "updated description";
AlertConfig updated = client.update(alertId, update);

// 8. Pause during maintenance
AlertConfig paused = client.pause(alertId);

// 9. Resume when done
AlertConfig resumed = client.resume(alertId);

// 10. Delete the alert
DeleteAlertResponse result = client.delete(alertId);

// 1. Set up the SDKimport com.browserstack.aisdk.AISDK;import com.browserstack.aisdk.clients.alert.Alert;import com.browserstack.aisdk.clients.alert.AlertConfig;import com.browserstack.aisdk.clients.alert.AlertConfigAggregation;import com.browserstack.aisdk.clients.alert.AlertConfigOperator;import com.browserstack.aisdk.clients.alert.AlertConfigScope;import com.browserstack.aisdk.clients.alert.AlertConfigWindowMinutes;import com.browserstack.aisdk.clients.alert.CreateAlertBody;import com.browserstack.aisdk.clients.alert.DeleteAlertResponse;import com.browserstack.aisdk.clients.alert.ListAlertsParams;import com.browserstack.aisdk.clients.alert.ListAlertsResponse;import com.browserstack.aisdk.clients.alert.NotificationTarget;import com.browserstack.aisdk.clients.alert.NotificationTargetChannel;import com.browserstack.aisdk.clients.alert.PaginationMeta;import com.browserstack.aisdk.clients.alert.UpdateAlertBody;import java.util.Collections;import java.util.HashMap;import java.util.List;import java.util.Map;AISDK sdk = AISDK.builder()    .publicKey(System.getenv("AISDK_PUBLIC_KEY"))    .secretKey(System.getenv("AISDK_SECRET_KEY"))    .build();Alert alerts = sdk.alert();// 2. Per-run variablesString name = "High p95 latency on production traces";// 3. Create an alertNotificationTarget webhook = new NotificationTarget();webhook.channel = NotificationTargetChannel.webhook;webhook.enabled = true;Map<String, Object> webhookConfig = new HashMap<>();webhookConfig.put("url", "https://example.com/sdk-test-webhook");webhook.config = webhookConfig;CreateAlertBody body = new CreateAlertBody();body.name = "High p95 latency on production traces";body.description = "Notify on-call when average trace latency exceeds 750 ms.";body.scope = AlertConfigScope.TRACE;body.aggregation = AlertConfigAggregation.AVG;body.metric = "latency";body.operator = AlertConfigOperator.GT;body.threshold = 750.0;body.windowMinutes = AlertConfigWindowMinutes.M_5;body.cooldownMinutes = 10;body.environments = Collections.singletonList("default");body.notifications = Collections.singletonList(webhook);AlertConfig alert = client.create(body);// 4. Grab the id for later stepsString alertId = alert.id;// 5. List alertsListAlertsParams params = new ListAlertsParams();params.page = 1;params.limit = 50;ListAlertsResponse res = client.list(params);// 6. Fetch it by idAlertConfig fetched = client.get(alertId);// 7. Update the thresholdUpdateAlertBody update = new UpdateAlertBody();update.threshold = 999.0;update.description = "updated description";AlertConfig updated = client.update(alertId, update);// 8. Pause during maintenanceAlertConfig paused = client.pause(alertId);// 9. Resume when doneAlertConfig resumed = client.resume(alertId);// 10. Delete the alertDeleteAlertResponse result = client.delete(alertId);

Setup

Put your public and secret keys in your environment, then create one SDK instance and reuse it for every call on this page.

import (
	"context"
	"log"
	"os"

	aisdk "github.com/browserstack/ai-sdk-go"
)

sdk, err := aisdk.New(aisdk.WithCredentials(
	os.Getenv("AISDK_PUBLIC_KEY"),
	os.Getenv("AISDK_SECRET_KEY"),
))
if err != nil {
	log.Fatalf("aisdk.New: %v", err)
}

import (	"context"	"log"	"os"	aisdk "github.com/browserstack/ai-sdk-go")sdk, err := aisdk.New(aisdk.WithCredentials(	os.Getenv("AISDK_PUBLIC_KEY"),	os.Getenv("AISDK_SECRET_KEY"),))if err != nil {	log.Fatalf("aisdk.New: %v", err)}

Create an alert

scope := AlertConfigScope("TRACE")
aggregation := AlertConfigAggregation("AVG")
metric := "latency"
operator := AlertConfigOperator("GT")
threshold := 750.0
description := "Notify on-call when average trace latency exceeds 750 ms."
cooldownMinutes := 10
environments := []string{"default"}

body := &CreateAlertBody{
	Name:            "High p95 latency on production traces",
	Description:     &description,
	Scope:           &scope,
	Aggregation:     &aggregation,
	Metric:          &metric,
	Operator:        &operator,
	Threshold:       &threshold,
	WindowMinutes:   5,
	CooldownMinutes: &cooldownMinutes,
	Environments:    &environments,
	Notifications: []NotificationTarget{
		{
			Channel: "webhook",
			Enabled: true,
			Config: map[string]interface{}{
				"url": "https://example.com/sdk-test-webhook",
			},
		},
	},
}

alert, err := client.Create(context.Background(), body)

scope := AlertConfigScope("TRACE")aggregation := AlertConfigAggregation("AVG")metric := "latency"operator := AlertConfigOperator("GT")threshold := 750.0description := "Notify on-call when average trace latency exceeds 750 ms."cooldownMinutes := 10environments := []string{"default"}body := &CreateAlertBody{	Name:            "High p95 latency on production traces",	Description:     &description,	Scope:           &scope,	Aggregation:     &aggregation,	Metric:          &metric,	Operator:        &operator,	Threshold:       &threshold,	WindowMinutes:   5,	CooldownMinutes: &cooldownMinutes,	Environments:    &environments,	Notifications: []NotificationTarget{		{			Channel: "webhook",			Enabled: true,			Config: map[string]interface{}{				"url": "https://example.com/sdk-test-webhook",			},		},	},}alert, err := client.Create(context.Background(), body)

The response includes everything the server saved — defaults it filled in for you, and the alert's ID, which you'll use for every follow-up call.

Creates a new alert in your project. The server validates the window size, metric, environments, filter columns, and each notification target before saving.

Param	Type	Required	Description
`name`	`string`	`true`	A name for the alert. 1–255 characters.
`description`	`string \| null`	`false`	Optional free-form description. Up to 500 characters.
`scope`	`'TRACE' \| 'SESSION'` "TRACE" \| "SESSION"	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`aggregation`	`string` "AVG" \| "MIN" \| "MAX" \| "P50" \| "P95" \| "P99" \| "SUM" \| "COUNT"	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`metric`	`string`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`operator`	`string` "GT" \| "LT" \| "GTE" \| "LTE"	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`threshold`	`number`	`false`	The value the metric is compared against.
`unit`	`string \| null`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`windowMinutes`	`number` 5 \| 10 \| 15 \| 30 \| 60 \| 360 \| 720 \| 1440 \| 4320 \| 10080	`true`	How far back to look when aggregating the metric.
`cooldownMinutes`	`number`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`environments`	`string[]`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`notifications`	`NotificationTarget[]`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Record<string, unknown> \| null`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`name`	`str`	`true`	A name for the alert. 1–255 characters.
`description`	`Optional[str]`	`false`	Optional free-form description. Up to 500 characters.
`scope`	`Optional[AlertConfigScope]` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`aggregation`	`Optional[AlertConfigAggregation]` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`metric`	`Optional[object]`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`operator`	`Optional[AlertConfigOperator]` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`threshold`	`Optional[float]`	`false`	The value the metric is compared against.
`unit`	`Optional[str]`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`window_minutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`true`	How far back to look when aggregating the metric.
`cooldown_minutes`	`Optional[int]`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`environments`	`Optional[list[str]]`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`notifications`	`list[NotificationTargetInput]`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Optional[dict[str, object]]`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`name`	`String`	`true`	A name for the alert. 1–255 characters.
`description`	`String`	`false`	Optional free-form description. Up to 500 characters.
`scope`	`AlertConfigScope` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`aggregation`	`AlertConfigAggregation` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`metric`	`String`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`operator`	`AlertConfigOperator` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`threshold`	`Double`	`false`	The value the metric is compared against.
`unit`	`String`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`windowMinutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`true`	How far back to look when aggregating the metric.
`cooldownMinutes`	`Integer`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`environments`	`List<String>`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`notifications`	`List<NotificationTarget>`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Map<String, Object>`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`Name`	`string`	`true`	A name for the alert. 1–255 characters.
`Description`	`*string`	`false`	Optional free-form description. Up to 500 characters.
`Scope`	`*AlertConfigScope` AlertConfigScopeTRACE, AlertConfigScopeSESSION	`false`	Whether the alert watches trace metrics or session metrics. Default: `"TRACE"`
`Aggregation`	`*AlertConfigAggregation` AlertConfigAggregationAVG, AlertConfigAggregationMIN, AlertConfigAggregationMAX, AlertConfigAggregationP50, AlertConfigAggregationP95, AlertConfigAggregationP99, AlertConfigAggregationSUM, AlertConfigAggregationCOUNT	`false`	How the metric is aggregated over the window before it's compared to the threshold. Required in Condition mode; derived from the SQL in SQL mode.
`Metric`	`*string`	`false`	A built-in metric, or `score:<name>` for a custom score. Required in Condition mode.
`Operator`	`*AlertConfigOperator` AlertConfigOperatorGT, AlertConfigOperatorLT, AlertConfigOperatorGTE, AlertConfigOperatorLTE	`false`	The comparison between the aggregated metric and the threshold. Required in Condition mode.
`Threshold`	`*float64`	`false`	The value the metric is compared against.
`Unit`	`*string`	`false`	An optional display unit, like `ms` or `USD`. Doesn't affect evaluation.
`WindowMinutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutesM_5, AlertConfigWindowMinutesM_10, AlertConfigWindowMinutesM_15, AlertConfigWindowMinutesM_30, AlertConfigWindowMinutesM_60, AlertConfigWindowMinutesM_360, AlertConfigWindowMinutesM_720, AlertConfigWindowMinutesM_1440, AlertConfigWindowMinutesM_4320, AlertConfigWindowMinutesM_10080	`true`	How far back to look when aggregating the metric.
`CooldownMinutes`	`*int`	`false`	Minimum time between fires. Keeps you from getting a wall of duplicate notifications. Default: `15`
`Environments`	`*[]string`	`false`	The environments the alert runs on. Leave empty to evaluate every environment. Default: `[]`
`Notifications`	`[]NotificationTarget`	`true`	One or more places to send the notification when the alert fires — webhook, email, or Slack.
`Notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`Notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`Notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`Filter`	`map[string]interface{}`	`false`	An optional filter to narrow what the alert evaluates. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

List alerts

page := 1
limit := 1
params := &ListAlertsParams{
	Page:  &page,
	Limit: &limit,
}
res, err := client.List(context.Background(), params)

page := 1limit := 1params := &ListAlertsParams{	Page:  &page,	Limit: &limit,}res, err := client.List(context.Background(), params)

Meta contains the pagination fields (Page, Limit, TotalItems, TotalPages). Asking for a page past the last one returns an empty Data slice — not an error.

Lists the alerts in your project, paginated. You can narrow the results by searching the name, or by filtering on status, scope, or metric.

Param	Type	Required	Description
`page`	`number`	`false`	1-indexed page number (default 1) Default: `1`
`limit`	`number`	`false`	Page size, max 100 (default 50) Default: `50`
`search`	`string`	`false`	Substring match on alert name (case-insensitive)
`status`	`'active' \| 'paused'` "active" \| "paused"	`false`	Filter by status — "active" or "paused"
`scope`	`'TRACE' \| 'SESSION'` "TRACE" \| "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`metric`	`string`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Param	Type	Required	Description
`page`	`Optional[int]`	`false`	1-indexed page number (default 1) Default: `1`
`limit`	`Optional[int]`	`false`	Page size, max 100 (default 50) Default: `50`
`search`	`Optional[str]`	`false`	Substring match on alert name (case-insensitive)
`status`	`Optional[str]` "active", "paused"	`false`	Filter by status — "active" or "paused"
`scope`	`Optional[str]` "TRACE", "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`metric`	`Optional[str]`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Param	Type	Required	Description
`page`	`Integer`	`false`	1-indexed page number (default 1) Default: `1`
`limit`	`Integer`	`false`	Page size, max 100 (default 50) Default: `50`
`search`	`String`	`false`	Substring match on alert name (case-insensitive)
`status`	`String` "active", "paused"	`false`	Filter by status — "active" or "paused"
`scope`	`String` "TRACE", "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`metric`	`String`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Param	Type	Required	Description
`Page`	`*int`	`false`	1-indexed page number (default 1) Default: `1`
`Limit`	`*int`	`false`	Page size, max 100 (default 50) Default: `50`
`Search`	`*string`	`false`	Substring match on alert name (case-insensitive)
`Status`	`*string` "active", "paused"	`false`	Filter by status — "active" or "paused"
`Scope`	`*string` "TRACE", "SESSION"	`false`	Filter by scope — "TRACE" or "SESSION"
`Metric`	`*string`	`false`	Exact match on the metric key (e.g. "latency", "score:relevance")

Get an alert by id

fetched, err := client.Get(context.Background(), alertID)

fetched, err := client.Get(context.Background(), alertID)

Get one alert by id

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Update an alert

Only the fields you send are updated — everything else stays the way it was. Handy for tweaking a threshold without rewriting the whole request.

threshold := 999.0
description := "updated description"
body := &UpdateAlertBody{
	Threshold:   &threshold,
	Description: &description,
}
updated, err := client.Update(context.Background(), alertID, body)

threshold := 999.0description := "updated description"body := &UpdateAlertBody{	Threshold:   &threshold,	Description: &description,}updated, err := client.Update(context.Background(), alertID, body)

Updates the alert. Only the fields you send are changed — anything you leave out stays the same. Pass `description: null` to clear the description.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id
`name`	`string`	`false`	New name. 1–255 characters.
`description`	`string \| null`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`scope`	`'TRACE' \| 'SESSION'` "TRACE" \| "SESSION"	`false`	Whether the alert watches trace metrics or session metrics.
`aggregation`	`string` "AVG" \| "MIN" \| "MAX" \| "P50" \| "P95" \| "P99" \| "SUM" \| "COUNT"	`false`	New aggregation over the window.
`metric`	`string`	`false`	New metric — a built-in metric or `score:<name>`.
`operator`	`string` "GT" \| "LT" \| "GTE" \| "LTE"	`false`	New comparison between the aggregated metric and the threshold.
`threshold`	`number`	`false`	New threshold.
`unit`	`string \| null`	`false`	New display unit. Pass `null` to clear.
`windowMinutes`	`number` 5 \| 10 \| 15 \| 30 \| 60 \| 360 \| 720 \| 1440 \| 4320 \| 10080	`false`	New look-back window in minutes.
`cooldownMinutes`	`number`	`false`	New cooldown between fires.
`environments`	`string[]`	`false`	New environments. Empty means evaluate every environment.
`notifications`	`NotificationTarget[]`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Record<string, unknown> \| null`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id
`name`	`Optional[str]`	`false`	New name. 1–255 characters.
`description`	`Optional[str]`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`scope`	`Optional[AlertConfigScope]` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics.
`aggregation`	`Optional[AlertConfigAggregation]` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	New aggregation over the window.
`metric`	`Optional[object]`	`false`	New metric — a built-in metric or `score:<name>`.
`operator`	`Optional[AlertConfigOperator]` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	New comparison between the aggregated metric and the threshold.
`threshold`	`Optional[float]`	`false`	New threshold.
`unit`	`Optional[str]`	`false`	New display unit. Pass `null` to clear.
`window_minutes`	`Optional[AlertConfigWindowMinutes]` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`false`	New look-back window in minutes.
`cooldown_minutes`	`Optional[int]`	`false`	New cooldown between fires.
`environments`	`Optional[list[str]]`	`false`	New environments. Empty means evaluate every environment.
`notifications`	`Optional[list[NotificationTargetInput]]`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Optional[dict[str, object]]`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id
`name`	`String`	`false`	New name. 1–255 characters.
`description`	`String`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`scope`	`AlertConfigScope` AlertConfigScope.TRACE, AlertConfigScope.SESSION	`false`	Whether the alert watches trace metrics or session metrics.
`aggregation`	`AlertConfigAggregation` AlertConfigAggregation.AVG, AlertConfigAggregation.MIN, AlertConfigAggregation.MAX, AlertConfigAggregation.P50, AlertConfigAggregation.P95, AlertConfigAggregation.P99, AlertConfigAggregation.SUM, AlertConfigAggregation.COUNT	`false`	New aggregation over the window.
`metric`	`String`	`false`	New metric — a built-in metric or `score:<name>`.
`operator`	`AlertConfigOperator` AlertConfigOperator.GT, AlertConfigOperator.LT, AlertConfigOperator.GTE, AlertConfigOperator.LTE	`false`	New comparison between the aggregated metric and the threshold.
`threshold`	`Double`	`false`	New threshold.
`unit`	`String`	`false`	New display unit. Pass `null` to clear.
`windowMinutes`	`AlertConfigWindowMinutes` AlertConfigWindowMinutes.M_5, AlertConfigWindowMinutes.M_10, AlertConfigWindowMinutes.M_15, AlertConfigWindowMinutes.M_30, AlertConfigWindowMinutes.M_60, AlertConfigWindowMinutes.M_360, AlertConfigWindowMinutes.M_720, AlertConfigWindowMinutes.M_1440, AlertConfigWindowMinutes.M_4320, AlertConfigWindowMinutes.M_10080	`false`	New look-back window in minutes.
`cooldownMinutes`	`Integer`	`false`	New cooldown between fires.
`environments`	`List<String>`	`false`	New environments. Empty means evaluate every environment.
`notifications`	`List<NotificationTarget>`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`filter`	`Map<String, Object>`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id
`Name`	`*string`	`false`	New name. 1–255 characters.
`Description`	`*string`	`false`	New description. Pass `null` to clear it. Up to 500 characters.
`Scope`	`*AlertConfigScope` AlertConfigScopeTRACE, AlertConfigScopeSESSION	`false`	Whether the alert watches trace metrics or session metrics.
`Aggregation`	`*AlertConfigAggregation` AlertConfigAggregationAVG, AlertConfigAggregationMIN, AlertConfigAggregationMAX, AlertConfigAggregationP50, AlertConfigAggregationP95, AlertConfigAggregationP99, AlertConfigAggregationSUM, AlertConfigAggregationCOUNT	`false`	New aggregation over the window.
`Metric`	`*string`	`false`	New metric — a built-in metric or `score:<name>`.
`Operator`	`*AlertConfigOperator` AlertConfigOperatorGT, AlertConfigOperatorLT, AlertConfigOperatorGTE, AlertConfigOperatorLTE	`false`	New comparison between the aggregated metric and the threshold.
`Threshold`	`*float64`	`false`	New threshold.
`Unit`	`*string`	`false`	New display unit. Pass `null` to clear.
`WindowMinutes`	`*AlertConfigWindowMinutes` AlertConfigWindowMinutesM_5, AlertConfigWindowMinutesM_10, AlertConfigWindowMinutesM_15, AlertConfigWindowMinutesM_30, AlertConfigWindowMinutesM_60, AlertConfigWindowMinutesM_360, AlertConfigWindowMinutesM_720, AlertConfigWindowMinutesM_1440, AlertConfigWindowMinutesM_4320, AlertConfigWindowMinutesM_10080	`false`	New look-back window in minutes.
`CooldownMinutes`	`*int`	`false`	New cooldown between fires.
`Environments`	`*[]string`	`false`	New environments. Empty means evaluate every environment.
`Notifications`	`*[]NotificationTarget`	`false`	New notification targets. Passing an empty array isn't supported — leave the field out to keep what's already there.
`Notifications.channel`	`"webhook" \| "email" \| "slack"`	`true`	How the notification is delivered.
`Notifications.enabled`	`boolean`	`true`	Whether this channel is active. Disabled channels are kept but skipped when the alert fires. Default: `true`
`Notifications.config`	`object`	`true`	Channel-specific settings (the shape depends on `channel`).
`Filter`	`map[string]interface{}`	`false`	New filter. `null` means "evaluate everything in scope." A non-null value has a `mode` field that's either `"conditions"` or `"sql"`.

Pause and resume

Pause() disables an alert without deleting it — useful during a maintenance window when you don't want false alarms. Resume() turns it back on. Both are simple wrappers around the /toggle endpoint.

paused, err := client.Pause(context.Background(), alertID)

paused, err := client.Pause(context.Background(), alertID)

resumed, err := client.Resume(context.Background(), alertID)

resumed, err := client.Resume(context.Background(), alertID)

Pause an alert without deleting its config. Convenience wrapper for `toggleAlert(alertId, false)`.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Re-enable a previously-paused alert. Convenience wrapper for `toggleAlert(alertId, true)`.

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id (returned from `create()`).

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id (returned from `create()`).

Delete an alert

result, err := client.Delete(context.Background(), alertID)

result, err := client.Delete(context.Background(), alertID)

Calling Get() on the same id afterwards returns an error mapped from HTTP 404.

Delete an alert

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Param	Type	Required	Description
`alert_id`	`str`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`String`	`true`	The alert's id

Param	Type	Required	Description
`alertId`	`string`	`true`	The alert's id

Complete example

Every step above, stitched together into one block you can copy and adapt. Fill in alertID where a later step needs the id returned by Create.

// 1. Set up the SDK
import (
	"context"
	"log"
	"os"

	aisdk "github.com/browserstack/ai-sdk-go"
)

sdk, err := aisdk.New(aisdk.WithCredentials(
	os.Getenv("AISDK_PUBLIC_KEY"),
	os.Getenv("AISDK_SECRET_KEY"),
))
if err != nil {
	log.Fatalf("aisdk.New: %v", err)
}

// 2. Per-run variables
name := "High p95 latency on production traces"

// 3. Create an alert
scope := AlertConfigScope("TRACE")
aggregation := AlertConfigAggregation("AVG")
metric := "latency"
operator := AlertConfigOperator("GT")
threshold := 750.0
description := "Notify on-call when average trace latency exceeds 750 ms."
cooldownMinutes := 10
environments := []string{"default"}

body := &CreateAlertBody{
	Name:            "High p95 latency on production traces",
	Description:     &description,
	Scope:           &scope,
	Aggregation:     &aggregation,
	Metric:          &metric,
	Operator:        &operator,
	Threshold:       &threshold,
	WindowMinutes:   5,
	CooldownMinutes: &cooldownMinutes,
	Environments:    &environments,
	Notifications: []NotificationTarget{
		{
			Channel: "webhook",
			Enabled: true,
			Config: map[string]interface{}{
				"url": "https://example.com/sdk-test-webhook",
			},
		},
	},
}

alert, err := client.Create(context.Background(), body)

// 4. Grab the id for later steps
alertID := alert.Id

// 5. List alerts
page := 1
limit := 1
params := &ListAlertsParams{
	Page:  &page,
	Limit: &limit,
}
res, err := client.List(context.Background(), params)

// 6. Fetch it by id
fetched, err := client.Get(context.Background(), alertID)

// 7. Update the threshold
threshold := 999.0
description := "updated description"
body := &UpdateAlertBody{
	Threshold:   &threshold,
	Description: &description,
}
updated, err := client.Update(context.Background(), alertID, body)

// 8. Pause during maintenance
paused, err := client.Pause(context.Background(), alertID)

// 9. Resume when done
resumed, err := client.Resume(context.Background(), alertID)

// 10. Delete the alert
result, err := client.Delete(context.Background(), alertID)

// 1. Set up the SDKimport (	"context"	"log"	"os"	aisdk "github.com/browserstack/ai-sdk-go")sdk, err := aisdk.New(aisdk.WithCredentials(	os.Getenv("AISDK_PUBLIC_KEY"),	os.Getenv("AISDK_SECRET_KEY"),))if err != nil {	log.Fatalf("aisdk.New: %v", err)}// 2. Per-run variablesname := "High p95 latency on production traces"// 3. Create an alertscope := AlertConfigScope("TRACE")aggregation := AlertConfigAggregation("AVG")metric := "latency"operator := AlertConfigOperator("GT")threshold := 750.0description := "Notify on-call when average trace latency exceeds 750 ms."cooldownMinutes := 10environments := []string{"default"}body := &CreateAlertBody{	Name:            "High p95 latency on production traces",	Description:     &description,	Scope:           &scope,	Aggregation:     &aggregation,	Metric:          &metric,	Operator:        &operator,	Threshold:       &threshold,	WindowMinutes:   5,	CooldownMinutes: &cooldownMinutes,	Environments:    &environments,	Notifications: []NotificationTarget{		{			Channel: "webhook",			Enabled: true,			Config: map[string]interface{}{				"url": "https://example.com/sdk-test-webhook",			},		},	},}alert, err := client.Create(context.Background(), body)// 4. Grab the id for later stepsalertID := alert.Id// 5. List alertspage := 1limit := 1params := &ListAlertsParams{	Page:  &page,	Limit: &limit,}res, err := client.List(context.Background(), params)// 6. Fetch it by idfetched, err := client.Get(context.Background(), alertID)// 7. Update the thresholdthreshold := 999.0description := "updated description"body := &UpdateAlertBody{	Threshold:   &threshold,	Description: &description,}updated, err := client.Update(context.Background(), alertID, body)// 8. Pause during maintenancepaused, err := client.Pause(context.Background(), alertID)// 9. Resume when doneresumed, err := client.Resume(context.Background(), alertID)// 10. Delete the alertresult, err := client.Delete(context.Background(), alertID)

Where to view results

Fired alerts show up in the dashboard under Project → Alerts on the Alert Events tab, and they also post to any notification channels you've set up (webhook, email, or Slack). See the Alerts UI guide for how the event lifecycle (FIRING → ACKNOWLEDGED → RESOLVED) works.

Alerts

On this page