Developer API

Bypass the dashboard.
Direct SCADA Integration.

Integrate high-frequency vibration telemetry directly into your digital twin, BIM model, or AWS Kinesis stream. Our edge nodes push JSON payloads over secure WebSockets or MQTT.

LIVE STRUCTURAL TWIN
NODE_MESH: ACTIVE

Stream Subscription

Subscribe to a live Kinesis data stream for a specific structural asset. Data is emitted at 50Hz for standard SHM.

WSSwss://api.asense.tech/v1/stream/{node_id}
const ws = new WebSocket('wss://api.asense.tech/v1/stream/A902', {
  headers: {
    'Authorization': 'Bearer ${ASENSE_API_KEY}',
    'X-Client-ID': 'scada-integration-prod'
  }
});

ws.onmessage = (event) => {
  const telemetry = JSON.parse(event.data);
  // Pipe to digital twin or timeseries DB
  digitalTwin.updateState(telemetry.node_id, telemetry.xyz_acceleration);
};

Payload Schema

The Edge DSP outputs a strict, uncompressed JSON structure. Peak Particle Velocity (PPV) is pre-calculated locally using Fast Fourier Transforms.

{
  "node_id": "A902",
  "timestamp": "2026-07-02T14:32:01.005Z",
  "sync_precision_ms": 0.05,
  "metrics": {
    "acceleration": {
      "x_mg": 1.24,
      "y_mg": -0.45,
      "z_mg": 9.82
    },
    "ppv_mm_s": 0.15,
    "inclination_deg": {
      "pitch": 0.005,
      "roll": -0.002
    }
  }
}

Authentication

All requests require an API key generated from the Asense Clarity dashboard. The key must be passed via the Authorization: Bearer header.

For sensitive government infrastructure, we offer IP-whitelisting and VPC peering options. Contact your field engineer to configure AWS PrivateLink.

Webhook & Email Alerts

Configure customizable thresholds for PPV, spectral peaks, or node health. When a threshold is breached, the platform fires an immediate webhook to your endpoint or dispatches formatted emails to stakeholders.

POSThttps://your-domain.com/webhook/asense-alert
{
  "alert_id": "evt_9831a2",
  "trigger": "PPV_THRESHOLD_EXCEEDED",
  "node_id": "A902",
  "threshold_configured": 2.5,
  "value_recorded": 3.12,
  "unit": "mm/s",
  "timestamp": "2026-07-02T14:45:10Z"
}

Data Lake Integration (Parquet)

For long-term modal analysis and AI training, Asense can automatically batch and export your RAW telemetry into an S3 bucket or Azure Blob Storage as compressed Apache Parquet files.

  • Columnar Efficiency: Query massive timeseries datasets using AWS Athena or Google BigQuery without unpacking JSON.
  • Automated Partitioning: Data is automatically partitioned by /year/month/day/node_id/.
  • Schema Evolution: Seamlessly handle new metrics as we roll out OTA updates to your edge nodes.

System Status

API endpoints 100% operational
Last updated: 2 min ago