GET api/v1/devices/{deviceId}/measurements/channel/{channel}/field/{field}/summary?startDate={startDate}&endDate={endDate}&aggregationPeriod={aggregationPeriod}

Summary (aggregated) measurements for the channel/field. This includes min, max, average, count etc.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
deviceId

globally unique identifier

Required

channel

integer

Required

field

string

Required

startDate

string

Default value is

endDate

string

Default value is

aggregationPeriod

Hourly aggregation or Daily aggregation

AggregationPeriod

Default value is Hourly

Body Parameters

None.

Response Information

Resource Description

MeasurementSummaryDto
NameDescriptionTypeAdditional information
StartTime

date

None.

EndTime

date

None.

AggregationPeriod

If each item in the items collection represents an houry or daily point.

AggregationPeriod

None.

Items

Collection of MeasurementSummaryItemDto

None.

Response Formats

application/json, text/json, application/senml+json

Sample:
{
  "StartTime": "2017-10-24T07:22:56.049846+00:00",
  "EndTime": "2017-10-24T07:22:56.049846+00:00",
  "AggregationPeriod": 0,
  "Items": [
    {
      "Channel": 1,
      "Field": "sample string 2",
      "Statistics": {
        "Count": 1,
        "Average": 2.0,
        "Min": 3.0,
        "Max": 4.0,
        "StandardDeviation": 5.1,
        "Sum": 6.0
      },
      "Points": [
        {
          "TimeSeconds": 1.0,
          "Value": 2.0
        },
        {
          "TimeSeconds": 1.0,
          "Value": 2.0
        }
      ],
      "CountsPerIntervalUnit": [
        {
          "TimeSeconds": 1.0,
          "Value": 2.0
        },
        {
          "TimeSeconds": 1.0,
          "Value": 2.0
        }
      ],
      "DateTime": "2017-10-24T07:22:56.049846+00:00",
      "DateTimeEpoch": 4.1
    },
    {
      "Channel": 1,
      "Field": "sample string 2",
      "Statistics": {
        "Count": 1,
        "Average": 2.0,
        "Min": 3.0,
        "Max": 4.0,
        "StandardDeviation": 5.1,
        "Sum": 6.0
      },
      "Points": [
        {
          "TimeSeconds": 1.0,
          "Value": 2.0
        },
        {
          "TimeSeconds": 1.0,
          "Value": 2.0
        }
      ],
      "CountsPerIntervalUnit": [
        {
          "TimeSeconds": 1.0,
          "Value": 2.0
        },
        {
          "TimeSeconds": 1.0,
          "Value": 2.0
        }
      ],
      "DateTime": "2017-10-24T07:22:56.049846+00:00",
      "DateTimeEpoch": 4.1
    }
  ]
}

application/xml, text/xml

Sample:
<MeasurementSummaryDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Measurements">
  <AggregationPeriod>Hourly</AggregationPeriod>
  <EndTime>2017-10-24T07:22:56.049846+00:00</EndTime>
  <Items>
    <MeasurementSummaryItemDto>
      <Channel>1</Channel>
      <CountsPerIntervalUnit>
        <MeasurementSummaryTimeValuePointDto>
          <TimeSeconds>1</TimeSeconds>
          <Value>2</Value>
        </MeasurementSummaryTimeValuePointDto>
        <MeasurementSummaryTimeValuePointDto>
          <TimeSeconds>1</TimeSeconds>
          <Value>2</Value>
        </MeasurementSummaryTimeValuePointDto>
      </CountsPerIntervalUnit>
      <DateTime>2017-10-24T07:22:56.049846+00:00</DateTime>
      <DateTimeEpoch>4.1</DateTimeEpoch>
      <Field>sample string 2</Field>
      <Points>
        <MeasurementSummaryTimeValuePointDto>
          <TimeSeconds>1</TimeSeconds>
          <Value>2</Value>
        </MeasurementSummaryTimeValuePointDto>
        <MeasurementSummaryTimeValuePointDto>
          <TimeSeconds>1</TimeSeconds>
          <Value>2</Value>
        </MeasurementSummaryTimeValuePointDto>
      </Points>
      <Statistics>
        <Average>2</Average>
        <Count>1</Count>
        <Max>4</Max>
        <Min>3</Min>
        <StandardDeviation>5.1</StandardDeviation>
        <Sum>6</Sum>
      </Statistics>
    </MeasurementSummaryItemDto>
    <MeasurementSummaryItemDto>
      <Channel>1</Channel>
      <CountsPerIntervalUnit>
        <MeasurementSummaryTimeValuePointDto>
          <TimeSeconds>1</TimeSeconds>
          <Value>2</Value>
        </MeasurementSummaryTimeValuePointDto>
        <MeasurementSummaryTimeValuePointDto>
          <TimeSeconds>1</TimeSeconds>
          <Value>2</Value>
        </MeasurementSummaryTimeValuePointDto>
      </CountsPerIntervalUnit>
      <DateTime>2017-10-24T07:22:56.049846+00:00</DateTime>
      <DateTimeEpoch>4.1</DateTimeEpoch>
      <Field>sample string 2</Field>
      <Points>
        <MeasurementSummaryTimeValuePointDto>
          <TimeSeconds>1</TimeSeconds>
          <Value>2</Value>
        </MeasurementSummaryTimeValuePointDto>
        <MeasurementSummaryTimeValuePointDto>
          <TimeSeconds>1</TimeSeconds>
          <Value>2</Value>
        </MeasurementSummaryTimeValuePointDto>
      </Points>
      <Statistics>
        <Average>2</Average>
        <Count>1</Count>
        <Max>4</Max>
        <Min>3</Min>
        <StandardDeviation>5.1</StandardDeviation>
        <Sum>6</Sum>
      </Statistics>
    </MeasurementSummaryItemDto>
  </Items>
  <StartTime>2017-10-24T07:22:56.049846+00:00</StartTime>
</MeasurementSummaryDto>