Knowledge Base
How can we help? 👋
All Categories
Automations & Integrations
Setting up your API Integration

Setting up your API Integration

Walks you through preparing and activating Scaler's API integration, including required meter setup and optional historical data imports for a smooth transition.

Last updated on January 15, 2026

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:

  1. Export meters from third-party system — Gather all meter identifiers and details
  1. Add meters in Scaler — Create meters with matching details for consistent mapping
  1. Upload historical data (optional) — Validate setup and gain early insights
  1. Map meters to third-party system — Connect Scaler meters to external meter IDs
  1. 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

Tip

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

Tip

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.

Note: Once the API integration is live, the API will automatically override historical data where newer values are available. However, having this early import gives you a solid starting point and helps confirm that the mapping and configuration are correct.

For detailed instructions on uploading consumption data, see Adding Meters & Consumption.

4. Mapping meters to your third-party system

Connect your Scaler meters to the external meter IDs from your third-party system. Depending on the number of meters, choose one of two approaches:

Option 1: Manual Mapping

Use this method for fewer than 20 meters:

  1. Map assets first — Before linking any meters, map each External asset ID to the corresponding Scaler asset ID
  1. Once assets are mapped, link the meters one by one
  1. Map each External meter ID to the Meter ID you created in Scaler
  1. Always fetch the latest information from Scaler to ensure accurate mapping

Warning

If an ID doesn't exist in Scaler, the mapping will fail.

Option 2: Bulk Mapping

Use this method for 20 or more meters:

  1. Prepare your data file containing both External asset ID and External meter ID values
  1. Map assets and meters simultaneously in the bulk mapping process
  1. Map each External asset ID to its Scaler asset ID, and each External meter ID to the Scaler meter ID
  1. Always fetch the latest data from Scaler before uploading to ensure all IDs exist and are correctly referenced

Warning

Always fetch data from Scaler before mapping. This ensures that all IDs are valid and prevents mapping errors.

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.

Did this answer your question?
😞
😐
🤩