Operations: How to Get Time Series

Definition

public GetTimeSeriesOperation(string docId, string timeseries, DateTime? @from = null, 
    DateTime? to = null, int start = 0, int pageSize = int.MaxValue)

Parameters

Return Value: TimeSeriesRangeResult

public class TimeSeriesRangeResult
{
    public DateTime From, To;
    public TimeSeriesEntry[] Entries;
    public long? TotalResults;

    //..
}

• Requesting a time series that doesn't exist will return null.
• Requesting an entries range that doesn't exist will return a TimeSeriesRangeResult object with an empty Entries property.

Exceptions
Exceptions are not generated.

// Get all values of a single time-series
TimeSeriesRangeResult singleTimeSeriesDetails = store.Operations.Send(
    new GetTimeSeriesOperation(documentId, "HeartRates", DateTime.MinValue, DateTime.MaxValue));

Definition

public GetMultipleTimeSeriesOperation(string docId, 
    IEnumerable<TimeSeriesRange> ranges, int start = 0, int pageSize = int.MaxValue)

Parameters

Pass GetMultipleTimeSeriesOperation a TimeSeriesRange instance For each entries range you want it to retrieve.

public class TimeSeriesRange
{
    public string Name;
    public DateTime From, To;
}

Return Value: TimeSeriesRangeResult

public class TimeSeriesDetails
{
    public string Id { get; set; }
    public Dictionary<string, List<TimeSeriesRangeResult>> Values { get; set; }
}

public class TimeSeriesRangeResult
{
    public DateTime From, To;
    public TimeSeriesEntry[] Entries;
    public long? TotalResults;

    //..
}

• When a time series or an entries range that do not exist are requested, the return value for the erroneous range is a TimeSeriesRangeResult object with an empty Entries property.

Exceptions
Exceptions are not generated.

• The time series parent-Document ID
• A TimeSeriesRange instance for each entries range you want it to retrieve.

// Get value ranges from two time-series using GetMultipleTimeSeriesOperation
TimeSeriesDetails multipleTimesSeriesDetails = store.Operations.Send(
        new GetMultipleTimeSeriesOperation(documentId, new List<TimeSeriesRange>
            {
                new TimeSeriesRange
                {
                    Name = "ExerciseHeartRate",
                    From = baseTime.AddHours(1),
                    To = baseTime.AddHours(10)
                },

                new TimeSeriesRange
                {
                    Name = "RestHeartRate",
                    From = baseTime.AddHours(11),
                    To = baseTime.AddHours(20)
                }
            }));