Skip to main content

​
Properties

​
aggregation?

optional aggregation?: "AVERAGE" | "COUNT" | "SUM" | "MIN" | "MAX" | "P90" | "P95" | "P99" | "MEDIAN"

​
Default

​
alert_type?

optional alert_type?: "DRIFT" | "AGGREGATE" | "PER_EVENT"

​
Default

​
description?

optional description?: string

​
filters

filters: object[]

​
field

field: string

​
operator

operator: "exists" | "not exists" | "is" | "is not" | "contains" | "not contains" | "greater than" | "less than" | "after" | "before"

​
type

type: "string" | "number" | "boolean" | "datetime"

​
value

value: string | number | boolean | null

​
frequency

frequency: "HOURLY" | "DAILY" | "WEEKLY" | "MONTHLY"

​
minimum_sample_size?

optional minimum_sample_size?: number

​
Default

​
name

name: string

​
notification_details

notification_details: object

​
critical

critical: object
critical.channel
channel: "EMAIL" | "SLACK" | "WEBHOOK"
critical.metadata
metadata: object
Index Signature
[key: string]: unknown
critical.scope
scope: "ALL_PROJECT_MEMBERS" | "SPECIFIC_MEMBER"
critical.user_ids?
optional user_ids?: string[]

​
resolved

resolved: object
resolved.channel
channel: "EMAIL" | "SLACK" | "WEBHOOK"
resolved.metadata
metadata: object
Index Signature
[key: string]: unknown
resolved.scope
scope: "ALL_PROJECT_MEMBERS" | "SPECIFIC_MEMBER"
resolved.user_ids?
optional user_ids?: string[]

​
project_id

project_id: string

​
Description

The unique identifier of the project the alert is created in

​
projections

projections: string[]

​
status?

optional status?: "ACTIVE" | "TRIGGERED" | "PAUSED" | "RESOLVED"

​
thresholds

thresholds: object

​
critical

critical: object
critical.operator
operator: "greater_than" | "less_than" | "equal_to"
critical.value
value: number

​
resolved

resolved: object
resolved.operator
operator: "greater_than" | "less_than" | "equal_to"
resolved.value
value: number