Run in Enrichment Spreadsheet
Use this function as a column step in
deepline enrich.deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=clickhouse_click_stack_create_alert:{"organizationId":"{{organizationId}}","serviceId":"{{serviceId}}"}' --json
Map payload values to spreadsheet columns with
{{column_name}} placeholders.Input Schema
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
payload.organizationId | string | Yes | ID of the organization that owns the service. | |
payload.serviceId | string | Yes | ID of the ClickStack service. | |
payload.dashboardId | string | No | Dashboard ID for tile-based alerts. | |
payload.tileId | string | No | Tile ID for tile-based alerts. Must be a line, stacked bar, or number type tile. | |
payload.savedSearchId | string | No | Saved search ID for saved_search alerts. | |
payload.groupBy | string | No | Group-by key for saved search alerts. | |
payload.threshold | number | No | Threshold value for triggering the alert. For between and not_between threshold types, this is the lower bound. | |
payload.thresholdMax | number | No | Upper bound for between and not_between threshold types. Required when thresholdType is between or not_between, must be >= threshold. | |
payload.interval | "1m" | "5m" | "15m" | "30m" | "1h" | "6h" | "12h" | "1d" | No | Evaluation interval for the alert. | |
payload.scheduleOffsetMinutes | integer | No | Offset from the interval boundary in minutes. For example, 2 with a 5m interval evaluates windows at :02, :07, :12, etc. (UTC). | |
payload.scheduleStartAt | string | No | Absolute UTC start time anchor. Alert windows start from this timestamp and repeat every interval. | |
payload.source | "saved_search" | "tile" | No | Alert source type (tile-based or saved search). | |
payload.thresholdType | "above" | "below" | "above_exclusive" | "below_or_equal" | "equal" | "not_equal" | "between" | "not_between" | No | Threshold comparison direction. | |
payload.channel | object | No | ||
payload.name | string | No | Human-friendly alert name. | |
payload.message | string | No | Alert message template. | |
payload.note | string | No | Freeform note for the alert. Supports markdown formatting. | |
payload.numConsecutiveWindows | integer | No | Fire the alert only after its condition has been met for this many consecutive evaluation windows. While the condition is met but fewer than this many consecutive windows have violated, the alert is in the PENDING state. |
Allowed values
| Field | Allowed values |
|---|---|
payload.interval | 1m, 5m, 15m, 30m, 1h, 6h, 12h, 1d |
payload.source | saved_search, tile |
payload.thresholdType | above, below, above_exclusive, below_or_equal, equal, not_equal, between, not_between |
Output Schema
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
result.data | object | Yes | Provider response payload. | |
result.meta | object | No | Additional response metadata (status, paging). |
Advanced: Direct CLI
Use direct execution for single payload debugging.
deepline tools execute clickhouse_click_stack_create_alert --payload '{
"organizationId": "string",
"serviceId": "string"
}' --json
CLI flags
| Flag | Description |
|---|---|
--json | Print machine-readable output. |
--wait | Wait for terminal provider status when supported. |
--debug | Enable wait mode with additional status/log output. |
--wait-timeout SECONDS | Max seconds to wait in wait mode. |
--poll-interval SECONDS | Polling interval in seconds during wait mode. |
--timeout SECONDS | Request timeout in seconds. |
--connect-timeout SECONDS | Connection timeout in seconds. |
Cost
- Pricing model:
fixed(per call). - Estimated Deepline credits:
0per pricing unit. - Provider-native pricing may still exist outside Deepline credit billing.
- Billing mode:
no_bill.