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. Retrieve Data

Conduit V4

Conduit V4 provides a minimal set of data, best used for applications that require values for updates where device data is already known.

PreviousRetrieve DataNextConduit V6

Last updated 1 year ago

Was this helpful?

SECURITY NOTE: Conduit V4 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.

Parameters

.

HTTP Method

GET Request

Base URL

https://api.alphax.cloud/conduitv4

Example Usage – Default

https://api.alphax.cloud/conduitv4?token=xxxxxxxxxxxxxxxxxxxxxx

Returns all data from last hour that the user has access to.

Common Example Usage – DeviceID and Channel

https://api.alphax.cloud/conduitv4?id=21xxx42dd37b&ch=4&token=xxxxxxxxxxxxxxxxxxxxxx

Returns last one hour data for Channel: 1 of Device: 21xxx42dd37b

{
  "channel":4,
  "networkID":"21xxx42dd37b",
  "value":0.278,
  "timestamp":"1537406384″
}

Example Usage – Date Range

https://api.alphax.cloud/conduitv4?token=xxxxxxxxxxxxxxxxxxxxxx&fcdt=1539792000&tcdt=1539840604

Returns all data values from date 1539792000 to 1539840604 for all devices the token has access to.

See section for HTTP parameters