HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Get Lookup Stats

Return summary statistics for a LOOKUP Property Key.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this endpoint to return summary statistics for a LOOKUP Property Key.

When to use this endpoint

Use GET /rest/public/properties/{propertyKey}/stats when you need to:

  • Inspect the date range covered by a lookup table.
  • Review the number of recorded lookup entries.
  • Check summary values such as mean value, duration, and last updated date.
  • Understand whether a lookup Property Key has been closed or retired.

Path parameter

ParameterTypeDescription
propertyKeyStringProperty Key name whose lookup statistics you want to retrieve.

Response fields

FieldTypeDescription
keyNameStringUnique name for the Property Key.
maxFromDateTimeDateTimeFinal instance in the lookup's recorded history.
maxToDateTimeDateTimeLatest instance in the lookup's recorded history.
meanValueDecimalMean cost value of all recorded lookup entries.
meanDurationIntegerComputed average duration, in minutes, that a lookup entry remains effective. Calculated as totalDuration ÷ lookupCount across the full lookup dataset for the Property Key.
missingDurationIntegerTotal duration, in minutes, for which lookup data is missing.
lastUpdatedDateDateTimeLast captured update for the lookup.
expectedNextUpdateDateDateTimeNext expected update if available, otherwise null.
minFromDateTimeDateTimeFirst instance in the lookup's recorded history.
lookupCountIntegerNumber of recorded entries in the lookup's history.
totalDurationIntegerTotal duration of time, in minutes, covered by the lookup entries.
closedDateTimeDate when the Property Key was closed or retired, otherwise null.
circle-info

meanDuration is computed as totalDuration ÷ lookupCount across the full lookup dataset for the Property Key. It is not filtered by fromDate or toDate. For hourly properties, values such as 59 or 60 can both be valid when historical timestamps include minor variations from exact hourly boundaries.

Related endpoints

Path Params
string
required
Defaults to hourlyPricingRealTimeERCOT

Property key name.

Responses

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