> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CreateAlertRequest

> TypeScript request type for the HoneyHive API

## Properties

### aggregation?

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

#### Default

```ts theme={null}
AVERAGE
```

***

### alert\_type?

> `optional` **alert\_type?**: `"DRIFT"` | `"AGGREGATE"` | `"PER_EVENT"`

#### Default

```ts theme={null}
AGGREGATE
```

***

### 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

```ts theme={null}
0
```

***

### 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`