Request
- Base URL: https://us.posthog.com
- URL: https://us.posthog.com/api/projects/{project_id}/vision/alerts/{id}/
- Auth: HTTP bearer
Path parameters
A UUID string identifying this vision alert configuration.
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request body
Unique identifier for this alert.
Scanner whose observations this alert watches. Immutable after creation.
Human-readable name for this alert. Defaults to 'Untitled alert' on create when omitted.
Whether the alert is active. Disabling a metric alert resets its state to not_firing.
- metric - Metric
- match - Match
- count - Count matching observations
- avg_score - Average score
- above - At or above
- below - At or below
Metric alerts only: the threshold value. Required for metric alerts, must be omitted for match alerts.
Metric alerts only: rolling window in days. Allowed values: [1, 3, 7, 14, 30].
Metric alerts only: evaluation cadence in minutes, at least 15.
- not_firing - Not firing
- firing - Firing
- pending_resolve - Pending resolve
- errored - Errored
- snoozed - Snoozed
- broken - Broken
Metric alerts only: total check periods in the sliding evaluation window (M in N-of-M).
Metric alerts only: how many periods must breach to fire (N in N-of-M).
Metric alerts only: minimum minutes between repeated notifications. 0 means no cooldown.
ISO 8601 timestamp until which the alert is snoozed. Set to null to unsnooze.
When the next evaluation is scheduled. Server-managed.
When the last notification was sent. Server-managed.
When the alert was last evaluated. Server-managed.
Consecutive evaluation failures. Resets on success. Server-managed.
When the alert was first enabled. Null means still a draft.
When the alert was created.
When the alert was last modified.
Response
Unique identifier for this alert.
Scanner whose observations this alert watches. Immutable after creation.
Human-readable name for this alert. Defaults to 'Untitled alert' on create when omitted.
Whether the alert is active. Disabling a metric alert resets its state to not_firing.
- metric - Metric
- match - Match
- count - Count matching observations
- avg_score - Average score
- above - At or above
- below - At or below
Metric alerts only: the threshold value. Required for metric alerts, must be omitted for match alerts.
Metric alerts only: rolling window in days. Allowed values: [1, 3, 7, 14, 30].
Metric alerts only: evaluation cadence in minutes, at least 15.
- not_firing - Not firing
- firing - Firing
- pending_resolve - Pending resolve
- errored - Errored
- snoozed - Snoozed
- broken - Broken
Metric alerts only: total check periods in the sliding evaluation window (M in N-of-M).
Metric alerts only: how many periods must breach to fire (N in N-of-M).
Metric alerts only: minimum minutes between repeated notifications. 0 means no cooldown.
ISO 8601 timestamp until which the alert is snoozed. Set to null to unsnooze.
When the next evaluation is scheduled. Server-managed.
When the last notification was sent. Server-managed.
When the alert was last evaluated. Server-managed.
Consecutive evaluation failures. Resets on success. Server-managed.
When the alert was first enabled. Null means still a draft.
When the alert was created.
When the alert was last modified.
Changes
No recorded changes to this operation across all 1 revision of this API.