URL Expired

The URL for this request expired after 30 days.

dispatch_event_types

array of objects

Optionally limit the event types to return in the response. By default, we include DAY_AHEAD, HOUR_AHEAD, CAPACITY_TEST and STANDARD.

Allowed:

HOUR_AHEAD``DAY_AHEAD``FIVE_MINUTE``CAPACITY_TEST``STANDARD

programs

array of strings | null

List of the programs we want to get data for. If not provided, we return data for all programs.

date_range_start

date-time

required

ISO-8601 timestamp of the first date to include in the results. This timestamp is inclusive, as opposed to date_range_end, which is exclusive. If an interval starts in the given date/time range, it will be included in the results. Note that there is a maximum of 31 days between date_range_start and date_range_end as the response might otherwise become too large.

date_range_end

date-time

required

ISO-8601 timestamp of the last date to include in the results. This timestamp is exclusive, as opposed to date_range_start, which is inclusive. If an interval starts in the given date/time range, it will be included in the results. Note that there is a maximum of 31 days between date_range_start and date_range_end as the response might otherwise become too large.

meter_ids

array of objects

required

List of meters to get data for.

interval

string

enum

Defaults to INTERVAL_15MIN

Interval of the data. Leap supports INTERVAL_15MIN and INTERVAL_1HR for now and we default to INTERVAL_15MIN. For 1-hour intervals, we roll up 15-min intervals and average the wh values. If we don't have exactly 4 15-min intervals to roll up into an hour worth of data, we simply ignore that entire hour.

Allowed:

INTERVAL_15MIN``INTERVAL_1HR

accept

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

application/json``text/csv

Response:

200      Returns list of meter performance objects.

object

meters

array of objects

required

meters*

object

meter_id

uuid

required

A unique identifier for the meter.

summary

object

required

Summary metrics for this meter in the requested date range.

events

array of objects

required

events*

object

meter_event_id

uuid

required

start_time_utc

date-time

required

end_time_utc

date-time

required

dispatch_quantity_w

double

required

dispatch_event_types

array of objects

required

Indicates the dispatch types (e.g. a capacity-test and day-ahead market award)

program

string

required

intervals

array of objects

required

intervals*

object

start_time_utc

date-time

required

end_time_utc

date-time

required

event_energy_wh

double

required

baseline_wh

double

required

performance_wh

double

required

Additional Performance Data:

array of objects

Additional performance data for the meter. The array will be present and populated for meters that have multiple baselines available. (e.g. An SCR meter can have both ACL and CBL baselines — both will be included in the array, each with its type_of_baseline value set to NYISO-ACL and NYISO-CBL respectively.)

additional_performance_data

object

baseline_wh

double

required

performance_wh

double

required

type_of_baseline

string

``400`` Returns 400 if the request is invalid. The response body will contain a detailed error message.

``429`` Returns 429 if the request is rate limited. The response body will contain a detailed error message.

---

Base URL

https://api.staging.leap.energy/v1.1/analytics/meter-performance

### Example CURL Request:

curl --request POST
--url https://api.staging.leap.energy/v1.1/analytics/meter-performance
--header 'accept: application/json'
--header 'content-type: application/json'
--data '\n{\n "interval": "INTERVAL_15MIN"\n}'

### Example Response:

{\n "meters": [\n {\n "meter_id": "e859c532-7852-4d6e-9084-305aa78b496b",\n "summary": {\n "event_energy_wh": 20.71,\n "baseline_wh": 403.79,\n "performance_wh": 383.08,\n "dispatch_quantity_wh": 556,\n "number_of_events": 1,\n "data_coverage": 50,\n "additional_performance_data": [\n {\n "baseline_wh": 202.79,\n "performance_wh": 100.08,\n "type_of_baseline": "NYISO-CBL"\n }\n ]\n },\n "events": [\n {\n "meter_event_id": "f4cfced0-16f4-4fb7-b72e-5ff939ae541e",\n "start_time_utc": "2023-06-15T01:00:00Z",\n "end_time_utc": "2023-06-15T02:00:00Z",\n "dispatch_quantity_w": 556,\n "dispatch_event_types": [\n "DAY_AHEAD",\n "CAPACITY_TEST"\n ],\n "program": "DRAM",\n "intervals": [\n {\n "start_time_utc": "2023-06-15T01:00:00Z",\n "end_time_utc": "2023-06-15T01:15:00Z",\n "event_energy_wh": 20.71,\n "baseline_wh": 403.79,\n "performance_wh": 383.08,\n "additional_performance_data": [\n {\n "baseline_wh": 202.79,\n "performance_wh": 100.08,\n "type_of_baseline": "NYISO-CBL"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}