Beebotte v1 API API Documentation

Read, Write & Publish Data
List Methods
Expand Methods

GETRead Data/v1/data/read/:channel/:resource

This method allows you to retrieve data records from a resource

Parameter	Type	Location	Description
channel	string	path	A channel name to read from (e.g. channel1)
resource	string	path	A resource name in the given channel to read from (e.g. resource1)
limit	int	query	Maximum number of resource records to return
source	enumerated	query	Indicates the source where to read data from (live or statistics) raw Instructs to read from the live records database hour-stats Instructs to read from the hour based statistics day-stats Instructs to read from the day based statistics
time-range	enumerated	query	Indicates the time range for the returned data. If source parameter is not set, the following rule applies. - if the time range is less or equal to 6hours the default source would be live. - if the time range is less or equal to 30 days, the default source would be hour-stats. - if the time range is larger than 30 days then the default source would be day-stats. If the source parameter is specified the data source will be the specified one. Beware that requesting records for the last 6month from the live source might include a large number of records. In this case, the limit parameter will apply. 1hour Reads data from the last hour 6hour Reads data from the last 6 hours 12hour Reads data from the last 12 hours today Reads data from this day yesterday Reads data from yesterday current-week Reads data from this week last-week Reads data from the last week current-month Reads data from this month last-month Reads data from the last month ytd Reads data from this year (year to date)

GETRead Public Data/v1/public/data/read/:user/:channel/:resource

This method allows you to retrieve data records from a public resource. This API method does not require any authentication.

Parameter	Type	Location	Description
user	string	path	A user name (e.g. beebotte)
channel	string	path	A channel name to read from (e.g. channel1)
resource	string	path	A resource name in the given channel to read from (e.g. resource1)
limit	int	query	Maximum number of resource records to return
source	enumerated	query	Indicates the source where to read data from (live or statistics) raw Instructs to read from the live records database hour-stats Instructs to read from the hour based statistics day-stats Instructs to read from the day based statistics
time-range	enumerated	query	Indicates the time range for the returned data. If source parameter is not set, the following rule applies. - if the time range is less or equal to 6hours the default source would be live. - if the time range is less or equal to 30 days, the default source would be hour-stats. - if the time range is larger than 30 days then the default source would be day-stats. If the source parameter is specified the data source will be the specified one. Beware that requesting records for the last 6month from the live source might include a large number of records. In this case, the limit parameter will apply. 1hour Reads data from the last hour 6hour Reads data from the last 6 hours 12hour Reads data from the last 12 hours today Reads data from this day yesterday Reads data from yesterday current-week Reads data from this week last-week Reads data from the last week current-month Reads data from this month last-month Reads data from the last month ytd Reads data from this year (year to date)

POSTWrite Resource/v1/data/write/:channel/:resource

This method allows you to write to a given channel resource

Parameter	Type	Location	Description
channel	string	path	A channel name to write to (e.g. channel1)
resource	string	path	A resource name in the given channel to write to (e.g. resource1)
data	json	body	Data to be written to the given resource.
ts	Integer	body	Timestamp associated to the record to write. The timestamp represents milliseconds since epoch. This parameter defaults to the current time when left blank

POSTBulk Write/v1/data/write/:channel

This method allows you to write multiple records in one API call

Parameter

Value

Type

Location

Description

channel

string

path

A channel name to write to (e.g. channel1)

records

json

body

Data records to be written to the given channel. it Must respect the following format:

records:[{

resource: (string, required) name of the resource
data: (object, required) data to be written to the resource
ts: (integer, optional) timestamp in milliseconds

}]

POSTPublish Resource/v1/data/publish/:channel/:resource

This method allows you to publish data to a given channel resource

Parameter	Type	Location	Description
channel	string	path	A channel name to publish data to (e.g. channel1)
resource	string	path	A resource name in the given channel to publish data to (e.g. resource1)
data	json	body	Data to be published to the given resource.
ts	Integer	body	Timestamp associated to the record to publish. The timestamp represents milliseconds since epoch.

POSTBulk Publish/v1/data/publish/:channel

This method allows you to publish multiple data records in one API call

Parameter

Value

Type

Location

Description

channel

string

path

A channel name to publish data to (e.g. channel1)

records

json

body

Data records to be published to the given channel. it Must respect the following format:

records:[{

resource: (string, required) name of the resource
data: (object, required) data to be published to the resource
ts: (integer, optional) timestamp in milliseconds

}]

Create and manage Channels
List Methods
Expand Methods

GETGet Channel/v1/channels/:channel
This method allows you to get the model of the given channel

Parameter Value Type Location Description
channel string
path
A channel name to get (e.g. channel1)
GETGet All Channels/v1/channels
This method allows you to get the models of all the channels you have created

Parameter	Value	Type	Location	Description
channel		string	path	A channel name to get (e.g. channel1)

POSTAdd Channel/v1/channels

This method allows you to create a new channel

Parameter	Type	Location	Description
name	string	body	The name of the channel to create. For a given user, the channel name MUST be unique (e.g. channel1)
label	string	body	User friendly label for this channel. If not provided, the channel name will be used as label as well
description	string	body	Description of the channel. Free text.
ispublic	boolean	body	Indicates if the channel is public (true) or private (false & default)
resources	json	body	Array of resources associated with the channel to create. it Must respect the following format: resources:[{ name: (string, required) name of the resource, MUST be unique for a channel label: (string, optional) user friendly label of the resource description: (string, optional) description of the resource vtype: (string, optional) indicates the data type for this resource. MUST be one of ['any', 'number', 'string', 'object'] sendOnSubscribe: (boolean, optional) indicates if clients should receive the most recent value of this resource upon subscription. default is false. }]

DELETEDelete Channel/v1/channels/:channel
This method allows you to delete a channel. Beware, you will loose all data associated with the channel.

Parameter Value Type Location Description
channel string
path
A channel name to delete (e.g. channel1)

Parameter	Value	Type	Location	Description
channel		string	path	A channel name to delete (e.g. channel1)

Create and manage Resources
List Methods
Expand Methods

GETGet Resource/v1/channels/:channel/resources/:resource
This method allows you to get the model of a resource

Parameter Value Type Location Description
channel string
path
A channel name to get resource from (e.g. channel1)
resource string
path
A resource name to get (e.g. resource1)
GETGet All Resources/v1/channels/:channel/resources
This method allows you to get the models of all the resources of a channel

Parameter Value Type Location Description
channel string
path
A channel name to get resources from (e.g. channel1)

Parameter	Value	Type	Location	Description
channel		string	path	A channel name to get resource from (e.g. channel1)
resource		string	path	A resource name to get (e.g. resource1)

Parameter	Value	Type	Location	Description
channel		string	path	A channel name to get resources from (e.g. channel1)

POSTAdd Resource/v1/channels/:channel/resources

This method allows you to add a new resource to a channel

Parameter	Type	Location	Description
channel	string	path	The name of the channel to add resource to (e.g. channel1)
name	string	body	The name of the resource to add. The resource name MUST be unique for a channel (e.g. resource1)
label	string	body	User friendly label for the resource to add. If not provided, the resource name will be used as label as well
description	string	body	Description of the resource. Free text.
vtype	string	body	Indicates the data type for this resource. Can be one of ['any', 'number', 'string', 'object'].
sendOnSubscribe	boolean	body	indicates if clients should receive the most recent value of this resource upon subscription. By default, this option is disabled.

DELETEDelete Resource/v1/channels/:channel/resources/:resource
This method allows you to delete a resource. Bewera, you will loose all data associated with the resource.

Parameter Value Type Location Description
channel string
path
A channel name (e.g. channel1)
resource string
path
A resource name to delate (e.g. resource1)

Read, Write & Publish DataList MethodsExpand Methods

Create and manage ChannelsList MethodsExpand Methods

Create and manage ResourcesList MethodsExpand Methods

Read, Write & Publish Data
List Methods
Expand Methods

Create and manage Channels
List Methods
Expand Methods

Create and manage Resources
List Methods
Expand Methods