Sign in

v2

latestOpenAPI 3.1.02026-07-312954143.9 KB
Constraints

List Shift Factors

Retrieve estimated shift factors for a constraint.

Queries ClickHouse linear_estimated_shift_factors for the given constraint, returning one row per location_gs_entity_id. When multiple source rows share the same location, estimated_shift_factor is aggregated per aggregation_function (mean, max, min, or median). Optional contingency_id restricts rows to a single contingency. Optional dataset_id filters on source_dataset. When exclude_zeros is true, source rows with estimated_shift_factor equal to zero are dropped before aggregating per location.

get/constraints/{constraint_id}/shift-factors

Path parameters

constraint_idstring required

GS entity ID of the constraint to get shift factors for

GS entity ID of the constraint to get shift factors for

Query parameters

api_keystring nullable

API key for authentication (query)

API key for authentication (query)

contingency_idstring nullable

When set, only include rows with this contingency_gs_entity_id

When set, only include rows with this contingency_gs_entity_id

dataset_idstring nullable

When set, only include rows with this source_dataset

When set, only include rows with this source_dataset

exclude_zerosboolean

When true, exclude rows where estimated_shift_factor is zero before aggregating each group

When true, exclude rows where estimated_shift_factor is zero before aggregating each group

aggregation_function'mean' | 'max' | 'min' | 'median'

Function used to combine source rows in each group: mean, max, min, or median

Function used to combine source rows in each group: mean, max, min, or median

Headers

x-api-keystring nullable

API key for authentication (header)

API key for authentication (header)

Response

Successful Response

location_gs_entity_idstring required
estimated_shift_factornumber required
locationstring required