Overview

The Get Channel Feed Summaries API is used to read feed summaries from all the sensor fields in a channel. This method can return either a JSON or CSV object. Each feed summary record consists hourly sum total, average, number of records, standard deviation, maximum and minimum values of each individual field.

API URL

To return a JSON object:

https://api.ubibot.io/channels/CHANNEL_ID/summary.json?parameters

To return a CSV file: (coming soon)

http://api.ubibot.io/channels/CHANNEL_ID/summary.csv?parameters 

Where CHANNEL_ID is the ID of the target channel.

HTTP Method

GET

URL Parameters

Name Type Required Description
api_key or token_id String Required for private channels Specify the API write key or read key of the channel, or token_id obtained after the user logged in.
results Integer Optional Number of entries to retrieve. The maximum number is 8,000
start Datetime Optional Start date in format YYYY-MM-DD%20HH:NN:SS.
end Datetime Optional End date in format YYYY-MM-DD%20HH:NN:SS.
timezone String Optional Identifier from Time Zones Reference for this request.
callback String Optional Function name to be used for JSONP cross-domain requests.

 Response

200 Success. Body contains a JSON object with the feed summaries in the requested format.  If is_truncated is presented in the response JSON and value is true, it means the result has been truncated because of the maximum number of entries for retrieving has been reached. You can change the start and end value to shrink the range.

Error: See the list of error codes for details.

Examples

GET https://api.ubibot.io/channels/123/summary?api_key=XXXXXXXXXXXXX

The response is a JSON object, for example:

PHP Quickstarts