GET sites/{id}/channels/{channelId}/data?startDateFilter={startDateFilter}&endDateFilter={endDateFilter}&intervalTypeFilter={intervalTypeFilter}&intervalNumberFilter={intervalNumberFilter}

Returns all data points for the channel, in the range between the start date and the end date, as specified by the siteid, channelid, startdate, and enddate parameters or by the interval type and interval number

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The id of the site

integer

Required

channelId

The id of the site's channel

integer

Required

startDateFilter

Both date parameters are in the ‘yyyyMMddHHmmss’ format with the time component being optional.

date

None.

endDateFilter

date

None.

intervalTypeFilter

This can be used to retrieve the last N intervals of data. For example, an interval type of ‘D’ and an interval number of ‘7’ would return the data from the past 7 days. An interval type of ‘HH’ and interval number of ‘12’ would return the data from the past 12 hours.Valid interval types are: 'Y', 'M', 'D', 'HH', 'MM', and 'SS'.

string

None.

intervalNumberFilter

string

None.

Body Parameters

None.

Response Information

Resource Description

ResponseVMOfDataPointVM
NameDescriptionTypeAdditional information
Resources

Collection of DataPointVM

None.

ResultCode

FwApiResultCode

None.

ResultMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Resources": [
    {
      "DataValue": "sample string 1",
      "DataTime": "2022-07-01T20:33:04.6145267-08:00"
    },
    {
      "DataValue": "sample string 1",
      "DataTime": "2022-07-01T20:33:04.6145267-08:00"
    }
  ],
  "ResultCode": 0,
  "ResultMessage": "sample string 1"
}

application/xml, text/xml

Sample:
<ResponseVMOfDataPointVMFXJgzlgx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FW.WebApi2.ViewModels">
  <ResultCode>Ok</ResultCode>
  <ResultMessage>sample string 1</ResultMessage>
  <Resources>
    <DataPointVM>
      <DataTime>2022-07-01T20:33:04.6145267-08:00</DataTime>
      <DataValue>sample string 1</DataValue>
    </DataPointVM>
    <DataPointVM>
      <DataTime>2022-07-01T20:33:04.6145267-08:00</DataTime>
      <DataValue>sample string 1</DataValue>
    </DataPointVM>
  </Resources>
</ResponseVMOfDataPointVMFXJgzlgx>