AlphaX API Reference Documentation
  • API Introduction
  • General Architecture
  • Authentication
  • Rate Limits
  • HTTP
    • HTTP Headers
    • HTTP Parameters
    • HTTP Compression
    • HTTP Error and Status Codes
    • SSL Requests
    • Sending Data
      • Uplink Data Format V1
      • Uplink Data Format V2
    • Retrieve Data
      • Conduit V4
      • Conduit V6
      • Conduit V7
        • Using Conduit V7
        • Aggregation Features (Optional)
        • Common Issues & Troubleshooting
        • Usage Examples
  • MQTT
    • MQTT Authentication
    • MQTT Broker Address
    • Publishing Data
      • MQTT Publish Format V1
      • MQTT Publish Format V2
Powered by GitBook
On this page

Was this helpful?

  1. HTTP
  2. Sending Data

Uplink Data Format V2

AlphaX API expects JSON with token, networkId, timestamp, and data array containing channelId and value. Supports advanced data integration and security features.

Best for Cloud to Cloud transfers

AlphaX expects a JSON formatted object with the following key:value pair format, and populated with the following data types.

{
  token : string; // conduit token from AlphaX Cloud
  networkId : string; // unique identifier on the network
  timestamp : integer; // 13 digit UTC timestamp
  data : array of objects // array of objects as defined below
}

Formatting the Data Array

The data array should be an array of Objects that are configured in the following key:value pair format:

data: [
 {
  channelId : integer; // the channel identifier for the value
  value : number; // the value of the data (16 digit maximum length)
  }
 ]

Example of complete data packet

{
 "token": "5b131223c67e7abcd81b0617",
 "networkId": "70B3D32111BD648F7",
 "timestamp": 1660962091000,
 "data": [
  {
   "channelId": 1,
   "value": 462.467835
   },
   {
   "channelId": 255,
   "value": 3.976
   }
  ]
 }

Note: AlphaX has several reserved channels. These are outlined in the channel plan help article. Please ensure that channel ID’s are correctly mapped to these channel numbers to take advantage of features such as battery life predictions and auto Geo-Location of devices.

PreviousUplink Data Format V1NextRetrieve Data

Last updated 1 year ago

Was this helpful?