Struct DatapointsQuery 

pub struct DatapointsQuery {

    pub id: IdentityOrInstance,
    pub start: Option<TimestampOrRelative>,
    pub end: Option<TimestampOrRelative>,
    pub limit: Option<u32>,
    pub aggregates: Option<Vec<String>>,
    pub granularity: Option<String>,
    pub include_outside_points: Option<bool>,
    pub target_unit: Option<String>,
    pub target_unit_system: Option<String>,
    pub include_status: Option<bool>,
    pub ignore_bad_data_points: Option<bool>,
    pub treat_uncertain_as_bad: Option<bool>,
    pub cursor: Option<String>,
}

Query data points

Fields

id: IdentityOrInstance

ID or external ID of time series to retrieve data from.

start: Option<TimestampOrRelative>

Get datapoints from, and including, this time.

end: Option<TimestampOrRelative>

Get datapoints up to, but excluding, this point in time.

limit: Option<u32>

Returns up to this number of data points. The maximum is 100000 non-aggregated data points and 10000 aggregated data points in total across all queries in a single request.

aggregates: Option<Vec<String>>

Specify the aggregates to return.

granularity: Option<String>

The time granularity size and unit to aggregate over. Valid entries are ‘day, hour, minute, second’, or short forms ‘d, h, m, s’, or a multiple of these indicated by a number as a prefix. For ‘second’ and ‘minute’, the multiple must be an integer between 1 and 120 inclusive; for ‘hour’ and ‘day’, the multiple must be an integer between 1 and 100000 inclusive.

For example, a granularity ‘5m’ means that aggregates are calculated over 5 minutes. This field is required if aggregates are specified.

include_outside_points: Option<bool>

Whether to include the last data points before the requsted time period and the first one after.

target_unit: Option<String>

The unit externalId of the data points returned. If the time series does not have a unitExternalId that can be converted to the targetUnit, an error will be returned. Cannot be used with targetUnitSystem.

target_unit_system: Option<String>

The unit system of the data points returned. Cannot be used with targetUnit.

include_status: Option<bool>

Show the status code for each data point in the response. Good (code = 0) status codes are always omitted. Only relevant for raw data points queries, not aggregates.

Default false

ignore_bad_data_points: Option<bool>

Treat data points with a Bad status code as if they do not exist.

If set to false, raw queries will include bad data points in the response, and aggregates will in general omit the time period between a bad data point and the next good data point. Also, the period between a bad data point and the previous good data point will be considered constant.

Default true

treat_uncertain_as_bad: Option<bool>

Treat data points with Uncertain status codes as Bad. If false, treat data points with Uncertain status codes as Good. Used for both raw queries and aggregates.

Default true

cursor: Option<String>

To retrieve next page, insert the nextCursor from a previous response. Be sure to match with the corresponding time series. Not compatible with includeOutsidePoints.

Trait Implementations

impl Clone for DatapointsQuery

fn clone(&self) -> DatapointsQuery

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DatapointsQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DatapointsQuery

fn default() -> DatapointsQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DatapointsQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DatapointsQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.