Meter Configuration

Participation Status

The Participation Status on a meter is used by partners to inform Leap if a customer meter should be enrolled in grid services and during what dates. It is very important for partners to keep the participation status of all meters up to date so that Leap can accurately enroll meters in demand response programs. For more details, see the Participation Status Guide.

By default, all meters start in Participate status (unless you requested Leap to change this default behavior) which means no action is needed unless you want to idle or disenroll a meter. If you’d like to change the default participation status for all new meters onboarded to the Leap platform, reach out to your Leap account manager.

Viewing Participation Status

To check the current and upcoming participation status of a meter, see Use Case E of the Sync Meter Inventory guide.

Endpoints

The following endpoints can be used to set and manage participation status (note the separate endpoints for single meter vs. bulk meter updates within each):

• Participate
  • Use to set date at which meter should start participating (e.g. to override and end an existing idle period or disenrolled meter)
  • Note that default behavior for all meters is to Participate indefinitely
• Idle
  • Use to temporarily remove this meter from all programs (e.g. when only participating in seasonal summer or winter programs or when hardware is offline for an extended period of time)
• Disenroll
  • Use to permanently disenroll a meter from all programs (e.g. based on customer request)
  • Note that if a meter is Active in a program, Leap will remove the meter from that program as soon as possible. This could be the end of the current month or season depending on the program.

Making a POST call on any of the above endpoints will overwrite existing participation periods as follows:

• If the new start time is in the middle of existing period, it would cut short and update the end time of that period.
• If the new end time is in the middle of existing period, it would cut short and update the start time of that period.
• If an existing period is fully encompassed within the new period, it would delete the existing period.

Failed 'Set to participate' program check

A failed 'Set to participate' status in the program checklists will prevent a meter from being enrolled. Use the participate endpoints to re-participate the meter if appropriate.

Reference ID

RefIDs are partner-defined strings that can be used to label meters on the Leap platform and assist in correlating and syncing data between Leap and a partner’s CRM or other internal systems. This is typically set as the unique identifier in the partner systems that corresponds to the customer site or device.

It is recommended to set this at meter onboarding in the Leap Connect URL for customer-authorized meters. For partner-created meters, this partner_reference value is required when uploading or creating each meter.

Endpoints

However, if the value was not set when onboarding via Leap Connect or you need to change the value for any reason, you can do so through the following endpoints:

• Update reference ID on a single meter
• Update reference ID in bulk for a group of meters

Meter Tags

One or more partner-defined tags can be placed on meters in order to help with internal partner tracking and communicate groups of meters to Leap.

Endpoints

The following endpoints can be used for managing tags:

• Add tags
• Remove tags
• Tags are shown within the Meter Details and Meter Enrollment endpoints.

Tag considerations:

• Only lowercase letters (a-z), digits (0-9), and hyphen (-) are allowed.

Missing or Changed Meter Fields

For meters created with the Create Meters API, you can overwrite all existing meter fields if needed. This may be necessary for:

• Program-specific required fields were missing when meter was initially created.
• The customer or device information has changed since the meter was created.

Endpoint

Use the Create Meters endpoint with the update_existing parameter set to true.

Nominations

A nomination is a forecast of a meter’s curtailment capacity in kW. The nomination set in the Leap platform represents the commitment amount that meter has made to the market for a given program in a given time period. For more details on nominations, see the Nominations Overview.

Leap calculates and sets nomination values for all meters based on a variety of factors. However, in some cases, it may be necessary for partners to directly suggest their own meter nominations.

Endpoint to View Nominations

Nomination values that have been or will be used by Leap for program enrollment is provided on a per meter, program, and time period basis.

• Search nominations to view existing nominations for one or more meters.

Endpoints to Suggest Nominations

To make and view suggested nominations for a single meter:

• Suggest meter nominations
• Get suggested nominations

To delete suggested nominations:

• Delete suggested nominations

Refresh Market Registration

If a customer has taken an action to resolve an eligibility issue on an ineligible meter, the endpoint below can be used to request a refresh of the market registration.

Refresh market registration for meter

🚧 This endpoint is currently only supported for refreshing market registration on utility meters.