EnergyCAP Developer
Documentation API Reference
Guides
Getting Started
Getting Started Environments API Authentication Paging Filters Field Reduction API Versioning Webhooks
SDKs
Overview C# SDK Python SDK (Beta) Angular/TypeScript SDK (Beta) PowerShell
SSO
Overview Microsoft Entra ID Okta
Reference
API Reference
Account AccountDigest AccountMeter Accrual Activity Admin Api ApiKey Audit Authentication Batch Bill BillAccountChargeSplit BillImageDownload BillImportRule BillSplit BillView Budget CalculatedBill Channel ChargebackEngine ChargebackTask ChargebackWorkflow Collection Commodity CommodityCategory CommodityDigest CostCategory CostCenter CostCenterDigest Country Customer Dashboard DataPoint DynamicReporting EdxAi EdxQuery EdxSchema EmissionRecord EmissionSource EnergyProject EnergyStar Environment EsaAlert EsaChannel EsaPlace EsaReading EsaReadingNote EUIGoal Export FileStore Filter Flag Formula GeneralLedger GHG Hierarchy Import List Me Meter MeterDigest MeterGroup MeterGroupDigest Notification Observation ObservationType Place PlaceBenchmark PlaceDigest PlaceGroup PlaceGroupDigest PostalCode PrimaryUse Rate RateDigest Report ReportDistribution Route Savings Schedule Search Sentinel Setup SummaryAccount SystemUser Tag Task Template TimeZone UDF Unit UserGroup UserRole UtilityPlatform Vendor VendorDigest Watts WattsAlert WattsReportDelivery WattsReportDistribution WeatherStation WebCaptureAccount WebCaptureCredential WebCapturePartner WebCaptureVendor Webhook Widget Workbench Workflow
API Reference / EsaAlert

EsaAlert

GET 4 endpoints
/api/v202608/esaalert/{esaAlertId} GetAlertDetailsV202608
Retrieves details for a specific, existing threshold alert
/api/v202608/esaalert/{alertId}/channels GetEligibleChannelsForAlertV202608
Lists channels eligible to be added to an existing threshold alert
/api/v202608/esaalert/enabledcounts GetEnabledAlertCountsV202608
Counts the enabled threshold alerts on each of several meters, across all of each meter's channels
/api/v202608/esaalert ListThresholdAlertsV202608
Retrieves a paginated list of threshold alerts
POST 2 endpoints
/api/v202608/esaalert/{esaAlertId}/channel AddAlertToChannelsV202608
Associates an existing threshold alert that has no channel with a single ESA channel
/api/v202608/esaalert CreateThresholdAlertV202608
Creates one Above/Below or Total Over Time threshold alert per ESA channel from a single alert definition
PUT 2 endpoints
/api/v202608/esaalert/{esaAlertId}/channel/{esaChannelId} SetChannelAlertEnabledV202608
Enables or disables a single ESA channel's association with a threshold alert
/api/v202608/esaalert/{esaAlertId} UpdateThresholdAlertV202608
Updates an existing Above/Below or Total Over Time threshold alert's definition
DELETE 2 endpoints
/api/v202608/esaalert/{esaAlertId} DeleteAlertV202608
Permanently deletes a threshold alert
/api/v202608/esaalert/{esaAlertId}/channel/{esaChannelId} RemoveAlertFromChannelV202608
Removes a single ESA channel's association with a threshold alert