vortexasdk.api.timeseries_item

TimeSeriesBreakdownItem

TimeSeriesBreakdownItem(*, id: typing.Optional[str],
                        label: typing.Optional[str],
                        value: typing.Optional[float],
                        count: typing.Optional[int])

model_config

TimeSeriesItem

TimeSeriesItem(
  *, key: typing.Optional[str], count: typing.Optional[int], breakdown:
    typing.Optional[typing.List[vortexasdk.api.timeseries_item.TimeSeriesBreakdownItem]],
  value: typing.Optional[float])

Generic container class holding a key <> value pair, a count of records contributing to the given value.

For example, this class could hold the total tonnage exported (value) on 2019-01-01 (key), and the count of cargo movements contributing to this tonnage aggregate, ie the number of cargo movements on this day (count).

model_config