API Reference

Get unresponsive meters

post
https://api.staging.leap.energy/beta/performance/diagnosis/monthly/unresponsive/meters

Retrieves unresponsive meters in a designated month

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

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

Body Params

Monthly unresponsive meters request body

string
required

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

string

Filters meters whose id contains the specified substring.

string

Filters meters whose partner reference contains the specified substring.

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
programs
array of objects

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

programs
historical_responsiveness
array of objects

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

historical_responsiveness
include_meter_programs
array of objects
length ≤ 100

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

include_meter_programs
exclude_meter_programs
array of objects
length ≤ 100

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

exclude_meter_programs
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.

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
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago