platform_alerts

get/api/projects/{project_id}/platform_alerts/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/platform_alerts/{id}/
  • Auth: HTTP bearer

Path parameters

idstring required
project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

idstring uuid required

Unique identifier of the alert configuration.

namestring required

Human-readable name of the alert.

enabledboolean required

Whether the alert is evaluated on schedule.

source_kind'logs' | 'insight' required
  • logs - Logs
  • insight - Insight
source_configobject required

Source-specific settings. The shape depends on source_kind. The bound the alert is evaluated against is under the condition key.

check_interval_minutesinteger required

Minutes between scheduled checks. Applies when recurrence_unit is null.

anchor_timestring nullable required

Local time (HH:MM in the project timezone) a calendar recurrence lands on. Null means the default anchor for the unit.

evaluation_periodsinteger required

Number of recent checks considered when deciding to fire.

datapoints_to_alarminteger required

Number of breaching checks within evaluation_periods required to fire.

cooldown_minutesinteger required

Minimum minutes between notifications for the same alert.

next_check_atstring date-time nullable required

When the next check is due. Null when no check is scheduled.

consecutive_failuresinteger required

Number of checks in a row that failed to evaluate.

legacy_configuration_idstring uuid nullable required

ID of the legacy source configuration this row was backfilled from. Null for alerts created on the platform.

created_atstring date-time required

When the configuration was created.

updated_atstring date-time required

When the configuration was last changed.

Changes

No recorded changes to this operation across all 1 revision of this API.