GetSummary
GET streams/{webId}/summary

Returns a summary over the specified time range for the stream.

Remarks

Count is the only summary type supported on non-numeric streams. Requesting a summary for any other type will generate an error. Time-weighted totals are computed by integrating the rate tag values over the requested time range. If some of the data are bad in the time range, the calculated total is divided by the fraction of the time period for which there are good values. This approach is equivalent to assuming that during the period of bad data, the tag takes on the average values for the entire calculation time range. The PercentGood summary may be used to determine if the calculation results are suitable for the application's purposes. For time-weighted totals, if the time unit rate of the stream cannot be determined, then the value will be totaled assuming a unit of "per day" and no unit of measure will be assigned to the value. If the measured time component of the tag is not based on a day, the user of the data must convert the totalized value to the correct units.

URL Parameters

Status Codes

200: The summaries that meet the specified conditions.

409: The data reference does not support this method.

Sample Response

{
  "Items": [
    {
      "Type": "Total",
      "Value": {
        "Timestamp": "2014-07-22T14:00:00Z",
        "UnitsAbbreviation": "m",
        "Good": true,
        "Questionable": false,
        "Substituted": false,
        "Annotated": false,
        "Value": 12.3
      }
    },
    {
      "Type": "Total",
      "Value": {
        "Timestamp": "2014-07-22T14:00:00Z",
        "UnitsAbbreviation": "m",
        "Good": true,
        "Questionable": false,
        "Substituted": false,
        "Annotated": false,
        "Value": 12.3
      }
    }
  ],
  "Links": {}
}
Enabling Operational Intelligence