Request
- Base URL: https://us.posthog.com
- URL: https://us.posthog.com/api/projects/{project_id}/platform_alerts/
- Auth: HTTP bearer
Path parameters
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
Product whose data the alert evaluates. It cannot change after the create.
Human-readable name of the alert. Defaults to 'Untitled alert'.
Whether the alert is evaluated on schedule. Defaults to true.
Number of recent checks considered when deciding to fire. Defaults to 1.
Number of breaching checks within evaluation_periods required to fire. Cannot exceed evaluation_periods. Defaults to 1.
Minimum minutes between notifications for the same alert. Defaults to 0.
Response
Unique identifier of the alert configuration.
Human-readable name of the alert.
Whether the alert is evaluated on schedule.
- logs - Logs
- insight - Insight
Source-specific settings. The shape depends on source_kind. The bound the alert is evaluated against is under the condition key.
Minutes between scheduled checks. Applies when recurrence_unit is null.
Local time (HH:MM in the project timezone) a calendar recurrence lands on. Null means the default anchor for the unit.
Number of recent checks considered when deciding to fire.
Number of breaching checks within evaluation_periods required to fire.
Minimum minutes between notifications for the same alert.
When the next check is due. Null when no check is scheduled.
Number of checks in a row that failed to evaluate.
ID of the legacy source configuration this row was backfilled from. Null for alerts created on the platform.
Time until which every instance's notifications are muted. Null when not muted. An instance's own snooze_until mutes one group, and the later of the two holds.
- ok - OK
- errored - Errored
- broken - Broken
New groups the last successful check could not track because the alert already held grouping.max_instances instances. 0 when every group fit.
Whether the last successful check cut its results before counting overflowed_groups. When true, more groups than overflowed_groups may be untracked.
- source - Source
- platform - Platform
When the configuration was created.
When the configuration was last changed.
Changes
- info
endpoint added
- info