Skip to content

MetricInterval

Source code in docs_src/capo_connect/types/metric_interval.py
class MetricInterval(TypedDict, closed=True):
    interval: NotRequired["capo_connect.types.interval_period.IntervalPeriod"]
    """<p>The interval period provided in the API request. </p>"""
    start_time: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp, in UNIX Epoch time format. Start time is based on the interval period selected. </p>"""
    end_time: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp, in UNIX Epoch time format. End time is based on the interval period selected. For example, If <code>IntervalPeriod</code> is selected <code>THIRTY_MIN</code>, <code>StartTime</code> and <code>EndTime</code> in the API request differs by 1 day, then 48 results are returned in the response. Each result is aggregated by the 30 minutes period, with each <code>StartTime</code> and <code>EndTime</code> differing by 30 minutes. </p>"""

end_time instance-attribute

end_time: NotRequired[Timestamp]

The timestamp, in UNIX Epoch time format. End time is based on the interval period selected. For example, If IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime in the API request differs by 1 day, then 48 results are returned in the response. Each result is aggregated by the 30 minutes period, with each StartTime and EndTime differing by 30 minutes.

interval instance-attribute

interval: NotRequired[IntervalPeriod]

The interval period provided in the API request.

start_time instance-attribute

start_time: NotRequired[Timestamp]

The timestamp, in UNIX Epoch time format. Start time is based on the interval period selected.