Alerts

Create an alert rule

Creates a source-aware grid-event or Radar threshold rule. Select reusable account-owned destinations by ID; omitting destinationIds preserves the account-email default for existing clients.

post/api/v1/alerts

Request

  • Base URL: https://askthegrid.com
  • URL: https://askthegrid.com/api/v1/alerts
  • Auth: HTTP bearer

Request body

namestring required
iso'ERCOT' | 'NYISO' | 'CAISO' | 'PJM' | 'MISO' | 'ISONE' | 'SPP' | 'BPAT' | 'TVA' | 'DUK' | 'CPLE' | 'CPLW' | 'FPC' | 'FPL' | 'SOCO' | 'BCA' | 'AESO' | 'IESO' | 'CENACE' | 'HQ' | 'BCH' | 'MHEB' | 'SPC' | 'NBSO' | 'NSIESO' nullable required
trigger'grid_event' | 'radar_threshold' | 'insight' | 'project' required
metric'nodal_lmp' | 'nodal_congestion' | 'dart_spread' | 'basis_spread' | 'rt_spread' | 'system_load' | 'reserve_headroom' | 'resource_adequacy_surplus' | 'reported_outages' | 'operating_margin' | 'regulation_up_capability' | 'renewable_curtailment' | 'forecast_divergence' | 'forecast_lmp'
operator'above' | 'below'
thresholdnumber
conditionKind'threshold' | 'percent_change' | 'moving_average'
lookbackMinutesinteger
confirmationMinutesinteger
recoveryMinutesinteger
missingDataPolicy'keep_state' | 'mark_unevaluable'
dailyNotificationLimitinteger
eventSeveritiesstring[]
destinationIdsstring[]
enabledboolean

Response

Success

oktrue required

Changes

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