Release Version: BetaRelease VersionBeta

Setup Instructions

1. Creating the Credentials

When adding your Sensemetrics integration, you will be prompted to create or select a set of Credentials. To create them, you need:

  • API Key - Retrieved from your Sensemetrics user profile

Follow these steps to get to your API Key:

  1. Log into the Sensemetrics portal.
  2. Click on your profile in the top right corner.
  3. Open the Development tab.
  4. Under API Key, copy your API key.

2. Creating the Integration

After creating or selecting your Credentials, IMSURGE will query the Sensemetrics API so you can select:

  • Project ID – chosen from your accessible projects.
  • Connection ID – chosen from within the selected project; this represents the sensor or device endpoint to update.

Reference

FieldDescriptionRequired
API KeySensemetrics API token✓
FieldDescriptionRequired
Project IDTarget project in Sensemetrics✓
Connection IDSpecific connection (sensor or device) within the project✓

Concerns & Limitations

  • API Keys Attached to Users - Since API keys are associated with Users instead of projects, if your user access to a project is revoked, it can disrupt pipeline executions. To avoid these issues, its good practice to create an entirely separate user for API access.
  • Pipeline-based configuration – iTwin device and sensor definitions are saved on the pipeline. Deleting a pipeline removes its associated devices and sensors.
    If you want to run multiple pipelines to the same iTwin device or sensors with different polling rates, use the Clone/Duplicate feature to copy a pipeline and adjust the polling rate on the clone. This can be useful for workflows such as having an hourly instrument sync alongside a nightly 24-hour backfill to capture out-of-order data from instruments that occasionally go offline.

External References