GRgridstatus
Constraints

List Constraint Stats By Interval

Changed on

Get per-interval count, shadow-price summary stats, and absolute cost.

get/constraints/{constraint_id}/stats

Request

Path parameters

constraint_idstring required

GS entity ID of the constraint to query

Query parameters

aggregation_period'hour' | 'day' | 'month' | 'year' required

Aggregation bucket size. One of "hour", "day", "month", "year".

api_keystring nullable

API key for authentication (query)

dataset_idstring required
timezonestring nullable

Optional IANA timezone (e.g. America/New_York). When provided, buckets are computed in this timezone.

start_timestring date-time nullable

Filter to rows where time index >= start_time (ISO 8601)

end_timestring date-time nullable

Filter to rows where time index < end_time (ISO 8601)

price_thresholdnumber nullable

Optional threshold. When set, only include rows where ABS(configured shadow price column) > price_threshold.

contingency_idstring nullable

Optional contingency GS entity ID filter.

Headers

x-api-keystring nullable

API key for authentication (header)

Response

Successful Response

interval_start_utcstring date-time required
binding_intervalsinteger nullable required
shadow_price_minnumber nullable required
shadow_price_meannumber nullable required
shadow_price_mediannumber nullable required
shadow_price_maxnumber nullable required
absolute_costnumber nullable required

Changes

  • de58449b43e2Revision changes
    • breaking

      removed the required property / from the response with the status

    • info

      added the required property / to the response with the status