Monthly unresponsive meters

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

include_summary

boolean

Defaults to false

Boolean flag indicating whether the response should include a summary of the requested data in addition to the detailed results.

t truefalse

Monthly unresponsive meters request body

year_month

string

required

^\d{4}-\d{2}$

ISO-8601 formatted year and month (YYYY-MM) representing the performance diagnosis month. meter_id_contains

string

Filters meters whose id contains the specified substring.

partner_reference_contains

string

Filters meters whose partner reference contains the specified substring.

customer_name_contains

string

Filters meters whose customer name contains the specified substring.

transmission_regions

array of objects

Filters meters whose transmission region is in the specified list of transmission regions.

transmission_regions

Show 8 enum values

ADD string

programs

array of objects

Filters meters whose program is in the specified list of programs.

programs

Show 32 enum values

ADD string

historical_responsiveness

array of objects

Filters meters whose historical responsiveness is in the specified list of historical responsiveness.

historical_responsiveness

Allowed:

NEVER_RESPONDS``RARELY_RESPONDS``NORMALLY_RESPONDS``NEW_METER

ADD string

include_meter_programs

array of objects

length ≤ 100

List of meter UUID, program pairs to include in the response.

include_meter_programs ADD object

exclude_meter_programs

array of objects

length ≤ 100

List of meter UUID, program pairs to exclude from the response.

exclude_meter_programs ADD object

page_token

string

If there are more records to fetch, this token will be populated as next_page_token in the response. Use it to fetch the next page. When requesting a CSV format via Accept header with value text/csv, this parameter is not required.

page_size

int32

Defaults to 100

Specifies the number of results to return. Defaults to 100 if not set, with a maximum limit of 1000 per page. When requesting a CSV format via Accept header with value 'text/csv', this parameter is not required.

sort

array of objects

Specifies the sorting criteria for the results. It is a list of fields by which the results should be sorted. This parameter is optional. Supported for meter_id, partner_reference, customer_name, customer_group, transmission_region, program, missed_revenue, nomination_kw, response_percentage, number_of_events, historical_responsiveness fields.

sort ADD object

content-type

string

enum

Defaults to application/json

Generated from available request content types

application/jsontext/csv

Allowed:

application/json``text/csv

``200 Retrieves monthly unresponsive meters for a specified month

object

summary

object

number_of_meters

int32

Total number of unresponsive meters.

missed_revenue

double

The difference between potential revenue and the actual revenue of the revenue report over the settlement period. Rounded to zero if actual revenue is greater than potential revenue.

average_response_percentage

double

Monthly average response percentage for meters.

meters

array of objects

required

meters*

object

meter_id

uuid

required

Meter UUID

partner_reference

string

Meter partner reference.

customer_name

string

Customer Name

customer_group

string

The Customer Group(s) associated with the customer. If the customer is part of multiple groups, they will be separated by a comma.

transmission_region

string

enum

required

Defines the transmission region of the meter

CAISO``ERCOT``NYISO``ISONE``PJM``SERC``WECC_SW``WECC_PC

program

string

enum

required

Identifier of program

CAISO-CCA-SC_ONLY``CAISO-HOLD_OPEN``CCA``CEC-DSGS-OPTION4``CEC-DSGS``CONED-CSRP``CONED-DLRP``DRAM``ELRP``ENERGY-ONLY``ERCOT-ERS``EVERSOURCE-CS``MA_DOER-CPS``NATGRID-CS``NRG-REALTIME``NRG-RED``NYISO-SCR``ONCOR-CLM``PGE-ART``PGE-CBP``PJM-CAPACITY``PSEGLI-CSRP``PSEGLI-DLRP``RIE-CS``UNITIL-CS``PSE-RPO``SRP-RPO``TVA-RPO``CAISO-ELRP-A4``CEC-DSGS-OPTION2``ENERGYHUB-CS``CT_GB-ESS

missed_revenue

double

nomination_w

double

Target quantity set for capacity market.

response_percentage

double

required

The meter’s event response percentage.

number_of_events

int32

required

Total number of events.

historical_responsiveness

string

enum

required

Shows the meter’s responsiveness for the last 12 months.

NEVER_RESPONDS``RARELY_RESPONDS``NORMALLY_RESPONDS``NEW_METER

year_month

string

^\d{4}-\d{2}$

ISO-8601 formatted year and month (YYYY-MM) representing the performance diagnosis month.

page_token

string

``400 Returns 400 if the request is invalid.

``401 Returns 401 if the request is unauthorized.

``403 Returns 403 if the request doesn't have the right values.

``415 Returns 415 if provided content in the request is not supported.

``500 Returns 500 if the there's an internal server error.

Updated 4 days ago

Base URL

https://api.staging.leap.energy/v1.1/performance/diagnosis/monthly/unresponsive/meters


xxxxxxxxxx

curl --request POST \

--url 'https://api.staging.leap.energy/v1.1/performance/diagnosis/monthly/unresponsive/meters?include_summary=false' \

--header 'accept: application/json' \

--header 'content-type: application/json' \

--data '{"page_size":100}'


xxxxxxxxxx

{

"summary": {

"number_of_meters": 0,

"missed_revenue": 20000.3,

"average_response_percentage": 75

},

"meters": [\
\
    {\
\
      "meter_id": "db0291d1-009d-4393-9a8d-4613a4efcd7a",\
\
      "partner_reference": "partner_reference",\
\
      "customer_name": "John Doe",\
\
      "customer_group": "Store Inc.",\
\
      "transmission_region": "CAISO",\
\
      "program": "CEC-DSGS",\
\
      "missed_revenue": 20000.3,\
\
      "nomination_w": 16600.88,\
\
      "response_percentage": 75,\
\
      "number_of_events": 6,\
\
      "historical_responsiveness": "NEVER_RESPONDS"\\
\
    },\
\
    {\
\
      "meter_id": "db0291d1-009d-4393-9a8d-4613a4efcd7a",\
\
      "partner_reference": "partner_reference",\
\
      "customer_name": "John Doe",\
\
      "customer_group": "Store Inc.",\
\
      "transmission_region": "CAISO",\
\
      "program": "CEC-DSGS",\
\
      "missed_revenue": 20000.3,\
\
      "nomination_w": 16600.88,\
\
      "response_percentage": 75,\
\
      "number_of_events": 6,\
\
      "historical_responsiveness": "NEVER_RESPONDS"\\
\
    }\
\
  ],

"year_month": "2023-03",

"page_token": "page_token"

}