(Last updated October 28, 2024) The scripts on this page use API Client-based authentication. Below, you’ll find sample PowerShell and Shell scripts to help you quickly automate data export from BEACON. These examples demonstrate how to interact with the EDS…
Blog Archives
API Clients
As part of our ongoing efforts to enhance BEACON security, we are migrating all BEACON Web Service API workflows from Basic Authentication to API Client credentials. All BEACON API users are urged to test and implement API Client credentials. API…
Need Help?
Knowledge Base
User Guide
- About
- Training
- UI
- At a Glance
- Data Exchange
- Data Exchange Search
- Data Diagnostics
- Service
- Account
- Geo Data Review
- Location
- Update
- Provision
- Swap
- Monitor
- Analytics
- Events
- Assets
- Original Assets Page
- Utility Notices
- Eye On Water Users
- Manage EOW
- Staff
- Customer Accounts
- Roles
- API Clients
- General Settings
- Notification Center
- Export Fieldsets
- Deep Links
- Reader Codes
- Handhelds
- Downloads
- Using BEACON Daily
- Onboarding
- DMA
- Integration
- Terminology
- CSV Files and Excel
- Quick Reference Guide to IDs
- Save CSV files in UTF-8 Format
- Sync BEACON and Billing Systems
- Understanding the Data Exchange Starter Spreadsheet
- Where Data Appears in BEACON
- Data Exchange Specification
- BEACON-to-CIS Schema Mapping
- Import Billing Meter Reads
- Import Interval Meter Reads
- Rules for Creating, Updating and Changing Data
- Update IDs
- Manually Provisioning Endpoints
- Endpoint Installation Form
- Search
- Data Exchange
- Billing Reads
- APIs
- Common Service API
- Import API
- Data Exchange Import API Use Case
- Import API cURL samples
- Export Data Services
- Import API cURL samples
- Export Data Service v1 API
- Export Data Service v2 API
- Export Fixed-Width Column Format Files
- Export Data Service Sample Scripts
- API Client Authentication EDS Sample Scripts
- Billing Read Export Specification
- FAQ
- How to Provision a Manually Read Meter
- Data Exchange FAQ
- Meter Configurations, IDs and Data Exchange
- Leak Reporting and Notifications
- Set and Edit Leak Alerts
- Continuous Flow vs. Leak Detected Alerts
- Data Backup, Recovery and Security
- Estimated Reads, Endpoints and Data Backfill
- How to Manage Accounts in BEACON
- How to bring new accounts, meters, and endpoints into BEACON?
- Leak Alert Flow Totals
- Export Billing Reads
- Export Reads for Accounts with Leaks or Backflow
- Export Reads for Subsets of Assets
- Correcting Mis-provisioned Meters
- FTP Import Support
- Direct Access to BEACON from External Systems
- Multiple Water Providers in One EOW Account
- Timezones and Timestamps
- Daylight Savings Time
- How to Register for a BEACON Account
- Correcting a Location ID = Account ID EOW Issue
- Data Exchange Errors FAQ
- Data Exchange Warnings FAQ
- How to Log In
- Reset and Change Passwords
- Weather Overlays
- EyeOnWater Weekly Comparisons
- Rollovers
- No Flow_Time or Flow in Read Exports
- Vacant Properties–Monitoring Flow at Inactive Services
- Can a Meter Have Current Reads with Tampers or Encoder Errors?
- Billing Read Exports for Compound Meters
- Export Reads After Meter Swaps
- Browser Downloads
- Filter Visibility and DMA Zones
- Fix Exceptions
- IR Tool Best Practice
- The Not Set Flag
- What Does the S in Endpoint Type CS Mean?
- User Counts on the Analytics, Engagement, and Monitor Pages
- Consumption Targets
- Deep Links Data Exchange
- Transaction History
- Cobalt
- BEACON Field
- EyeOnWater
- Data Exchange Requirements
- Branding Options
- Creating a Branded URL
- Branding Requirements
- EyeOnWater CSR FAQ
- Essential Reading for CSRs
- Troubleshooting Customer Account Creation Issues
- Unable to Find Account
- Customer Not Seeing Current Usage
- Unable to Link Account
- Common EOW Error Messages & What They Mean
- How to View More than One Account in EOW
- Linking EOW Accounts in More than One Utility
- Changing a Customer’s EOW Email Address
- EOW Login Issues
- Delete Account Requests
- EOW Password Issues
- Remove Customer Email and Text Message Numbers from a Leak Alert
- Appendix
- Sensor Data
- BEACON to ORION Mobile Read Mapping
- About Reads
- Installing and Provisioning Endpoints
- ORION Status Checker
- Register Resolution Values
- Exceptions – Health Module Status Indicators
- Exception History Exports: List of Meter, Endpoint, and Encoder Alerts
- Exceptions and Their Effect on Reads
- Tags
- Endpoint Firmware Updates
- Endpoint Interval Capture & Communication
- Endpoint Types and Serial Numbers
- Glossary of Terms
- Minimum System Requirements
- URL Whitelisting Guidance
Follow via Email