solarforecastarbiter.io.api.APISession.get_aggregate_values¶
-
APISession.
get_aggregate_values
(aggregate_id, start, end, interval_label=None, request_limit='365D')[source]¶ Get aggregate values from start to end for aggregate_id from the API
Parameters: - aggregate_id (string) – UUID of the aggregate object.
- start (timelike object) – Start time in interval to retrieve values for
- end (timelike object) – End time of the interval
- interval_label (str or None) – If beginning or ending, return only data that is valid between start and end. If None, return any data between start and end inclusive of the endpoints.
- request_limit (string) – Timedelta string describing maximum request length. Defaults to 365 days.
Returns: pandas.DataFrame – With a datetime index and (value, quality_flag) columns
Raises: ValueError
– If start or end cannot be converted into a Pandas Timestamp