Purpose of this article
This article guides you through the complete process of integrating a third-party API with Scaler, from exporting meter data to validating your connection, ensuring accurate and automated data flows.
Integration workflow overview
The process of setting up your API integration follows these steps:
- Export meters from third-party system — Gather all meter identifiers and details
- Add meters in Scaler — Create meters with matching details for consistent mapping
- Upload historical data (optional) — Validate setup and gain early insights
- Map meters to third-party system — Connect Scaler meters to external meter IDs
- Validate integration — Confirm all data flows correctly
1. Exporting meters from your third-party system
Start by requesting or generating a complete export of your meters from the third-party system.
Required meter information
Your export should include:
- Unique meter IDs and corresponding meter descriptions
- Resource types (electricity, gas, water, etc.)
- Source (grey, green, etc.)
- Location or area associations
- Meter start dates
Double-check that all meters relevant to your integration are included. Export data in a structured format such as CSV or Excel for easier import into Scaler. Keep a backup of this export as your reference point for validation.
2. Adding meters in Scaler
Create meters in Scaler using the details from your third-party export.
Creating each meter
Include the following information for each meter:
- Meter name and type
- Associated asset or site
Meter start date— consumption will be included in reports and analytics from this date forward
- Optional: Any tags or grouping that match your existing structure
Use the same meter IDs as the ones from the third-party system. This makes it much easier to map and match data automatically once the API integration is live.
Verification checklist:
- Each meter is added and correctly linked to an asset
- Meter type and area type match the third-party export
For detailed instructions on creating meters, see Setting up physical meters.
3. Uploading historical data (optional)
Before activating the live API connection, upload any historical data currently available from your third-party export.
Benefits of uploading historical data
Uploading historical data before API activation helps you:
- Validate that your meters are set up correctly
- Gain insights into past performance before live data starts flowing
- Ensure your dashboards and reports already display meaningful trends
You can upload the data via Scaler's bulk import tool.
"Once the API integration is live, any manually entered data that overlaps with the API's date range will cause sync errors. Before activating the integration, remove any manually entered data for periods the API will cover. Data outside the API's available history is unaffected and can remain in place.”
For detailed instructions on uploading consumption data, see Setting up physical meters.
What happens to your manually entered data after the API goes live
Before activating the API integration, you need to remove any manually entered data that falls within the date range the API will cover. If overlapping data exists when you try to sync, you will see errors and the sync will not complete successfully.
What to do before activation:
- Identify the earliest date the API will provide data for
- Delete any manually entered consumption data from that date forward
- Data outside the API's range (older than the API's available history) can stay in place and will not be affected
After activation:
- The API will populate data for all periods it covers
- Any manually entered data for periods before the API's range remains intact and continues to be available for reporting
Tip: If you uploaded historical data specifically to validate your meter setup, make sure to delete it for any periods the API will cover before going live.
4. Mapping meters to your third-party system
Once the connection is live, your provider's sites and meters appear on the Automations page (Data Collection Portal → Portfolio → Automations → API Mapping). Map each asset with Map Asset, then link meters with Map Meters — or use the bulk upload file for portfolios with many meters.
The full workflow, including the bulk upload file and validation rules, is covered in Mapping assets and meters on the Automations page.
If an ID doesn't exist in Scaler, the mapping will fail. Create all meters in Scaler (step 2) before mapping.
5. Validating your integration
After completing the mapping process, perform a final check to ensure everything is configured correctly.
Final validation checklist:
- Confirm all meters appear correctly in Scaler
- Verify that uploaded historical data matches what's in the third-party system
- Document the meter ID mapping for easy troubleshooting later
- Check that live data begins flowing from the expected date
Troubleshooting & common mistakes
Mapping failures during bulk upload → Verify that all Scaler meter IDs and asset IDs exist before uploading. Fetch fresh data from Scaler to ensure IDs are current.
Missing meters after integration → Check that every meter from your third-party export has a corresponding meter created in Scaler. Compare your original export with the meters in Scaler to identify gaps.
Historical data not appearing → Confirm that Meter start date is set earlier than or equal to the oldest historical data point you uploaded.
Duplicate or conflicting data → Ensure that meter IDs are unique and that no two meters share the same external ID mapping.
Additional resources
- API integration requirements — Technical and organizational requirements for API integrations
- Switching third-party API providers — How to transition between data providers
- ENERGY STAR connection set-up — Integrate your ENERGY STAR Portfolio Manager account with Scaler
- Setting up physical meters — How to create and configure meters in Scaler