Constraints

List Constraint Binding Counts By Period

Summarize unique binding constraints per UTC period for a dataset.

get/constraints/binding/counts

Request

Base URL
https://api.gridstatus.io/v1
Auth
none declared
TypeScript
https://skmtc.dev/gridstatus/apis/grid-status-api/docs/constraints/binding/counts/get.ts
A function with typed inputs. Its response is checked against the schema.

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

UTC aggregation period for grouping counts. Supported values: hour, day, month, year.

api_keystring nullable

API key for authentication (query)

dataset_idstring required

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 timestamp)

price_thresholdnumber nullable

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

x-api-keystring nullable

API key for authentication (header)

Successful Response

period_start_utcstring date-time required

binding_constraint_countinteger required

binding_constraint_idsstring[] required

No recorded changes to this operation across all 14 revisions of this API.