List Constraint Costs For Location

Get location-adjusted constraint costs over a time range.

The endpoint computes total cost per constraint/contingency pair from the specified constraint dataset in ClickHouse, then multiplies each by the location's aggregated shift factor (mean) from linear_estimated_shift_factors for the same dataset. For datasets without contingency_gs_entity_id, costs are computed per constraint and reused across that constraint's shift-factor contingency rows.

Pass group_by=constraint to roll contingency-grained rows up to one row per constraint (sum of adjusted_cost, mean shift_factor; contingency fields are null). total_cost is summed when the dataset has a contingency column; otherwise the shared per-constraint cost is kept once.

location_gs_entity_idstring required

dataset_idstring required

start_timestring date-time required

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

end_timestring date-time required

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

group_by'constraint' | 'constraint_contingency'

Row grain. constraint_contingency (default) returns one row per constraint/contingency pair. constraint rolls those rows up to one row per constraint (sum of adjusted_cost, mean shift factor; total_cost summed only when the dataset has a contingency column).

api_keystring nullable

API key for authentication (query)

x-api-keystring nullable

API key for authentication (header)

Response

Successful Response

constraint_gs_entity_idstring required

constraint_namestring required

contingency_gs_entity_idstring nullable required

contingency_namestring nullable required

shift_factornumber required

total_costnumber nullable required

adjusted_costnumber nullable required

v3

List Constraint Costs For Location

Path parameters

Query parameters

Headers

Response