Using Conduit V7

API Parameters When timerange Applied and Valid, return the data from last timerange seconds. When timerange Not Applied or Invalid and fcdt & tcdt Applied and Valid, return the data from fcdtto tcdt.

SECURITY NOTE: Conduit V7 uses GET method so request data forms part of the URL. This means your security token could potentially be stored in browser history or in web server logs.

Pre-requisites

Before you can access the API endpoint, ensure that:

• You have a valid token for authentication.

• If you haven’t activated your token yet, please refer to https://minnovation.com.au/knowledge-base/how-to-enable-conduit-for-a-user/ on how to enable Conduit for a user

HTTP Method

GET Request

Base URL

https://api.alphax.cloud/conduitv7

API Parameters

Parameter	Description	Input	Required
token	The unique security token for each user. This is available from the User window in AlphaX.	String	Required
fcdt	From Created Date Time, the starting range timestamp in seconds. If not defined or invalid, you will get data of last one hour. This parameter definition requires valid ‘tcdt’ parameter definition to work as desired.	10 digits Integer	Optional
tcdt	To Created Date Time, the ending range timestamp in seconds. If not defined or invalid, you will get data of last one hour. This parameter definition requires valid ‘fcdt’ parameter definition to work as desired	10 digits Integer	Optional
timerange	Date time range in seconds. Valid Values: 3600(Last 1 Hour), 86400(Last 24 Hours), 604800(Last 7 Days), 2592000(Last 30 Days)	Integer	Optional
id	The network ID that is used to register and track the device in the AlphaX system. If not defined, you will get data values for all devices the user has site access to.	String	Optional
ch	The individual channel ID that is assigned within the AlphaX system. If not defined, you will get data values for all the channels of the requested devices.	Integer	Optional
siteid	The id of Entity(Heirarchy). You will get data values for all devices that assigned to the site and its sub sites. If not defined, you will get data values for all devices the user has site access to.	String	Optional
showhidech	If true, include channels marked as hidden in the AlphaX platform. Default functionality is to not provide channels that are hidden.	boolean	Optional
tagfilter	If defined, retrieve only the devices whose tags include the input string.	String	Optional
status	If defined, retrieve only the devices whose status(labelName) include the input string.	String	Optional
limit	Maximum amount of datapoints per sensor(channel). If is 0 or not defined, the limit is 100000.	Integer (0-100000)	Optional
timezone	Output timezone. If not defined, use the timezone of the token. If the timezone of the token is not defined, use ‘GMT’.	String	Optional
groupby	Group type. If not defined, group & aggregate are disabled. You will get live data values.	String	Optional
aggregateby	aggregate type. If not defined, group & aggregate are disabled. You will get live data values.	String	Optional
pregroup1	Pre group type#1	String	Optional
preaggregate1	Pre aggregate type #1	String	Optional
pregroup2	Pre group type#2	String	Optional
preaggregate2	Pre aggregate type #2	String	Optional
pregroup3	Pre group type#3	String	Optional
preaggregate3	Pre aggregate type #3	String	Optional

Date Ranges

When timerange Applied and Valid Conduit will return the data from current date/time minus timerange in seconds. If timerangeNot Applied or timerange not valid ConduitV7 will return data for last 1 hour.

When fcdt & tcdt applied and valid, conduit will override timerange and return the data from fcdtto tcdtas long as they remain within the limit set and/or rate limt of the API.

Data Format

The response from the API will be in the JSON format. Below is the structure of the data you will receive.

[{
    "channelDescription": "",
    "id": "",
    "chid": "",
    "netid": "",
    "data": [
        {"timestamp": "", "value": ""},
        {"timestamp": "", "value": ""} // Repeats for all valid data
    ],
    "deviceName": "",
    "labelColor": "",
    "labelName": "",
    "location": "",
    "locationSensor": "",
    "tag": "",
    "unit": "",
    "timezone": "",
    "siteid": "",
    "sensorType": "",
    "limitData": "",
    "limitOutput": "",
    "cal": "",
    "offset": "",
    "maxVal": "",
    "minVal": ""
}]

Field Descriptions

• channelDescription: Description of the channel.

• id: Unique identifier for the sensor.

• chid: Channel identifier.

• netid: Network identifier.

• data: Array of data points, each containing a timestamp and value.

• deviceName: Name of the device.

• labelColor: Color assigned to the label.

• labelName: Name of the label.

• location: Information about the location of sensors.

• locationSensor: Location sensor information for virtual channels.

• tag: Tag related to the device.

• unit: Measurement unit of the data.

• timezone: The timezone in which the data is represented.

• siteid: Entity identifier.

• sensorType: Type of sensor.

• limitData: Indicates if the input record limit has been reached (maximum of 843000 datapoints).

• limitOutput: Indicates if the request data limit has been reached (maximum of 105120 datapoints).

• cal: Data calibration factor.

• offset: Data calibration offset.

• maxVal: Maximum data value.

• minVal: Minimum data value.