Skip to main content
CredentialsBefore using this method, retrieve your API key and the appropriate Sift URL for your environment. See Authentication.
Sift accepts data from any Influx client. Use your Sift API key as the Influx authentication token. Pass a small configuration object as a base64-encoded JSON string via the Influx org property.

​
Configuration object

{
  "run": {
    "name": "your run name",
    "run_key": "a unique identifier for this run"
    "tags": ["any", "tags", "associated", "with", "this", "run"]
  },
  "map_bucket_to_tag": "",
  "omit_bucket": false,
  "asset_source_tags": ["tag-1", "tag-2"]
}

​
Configuration fields

FieldRequiredDescription
runOptionalRun information. If omitted, data is not grouped into a Run.
run.nameRequired if run is setThe name of the Run.
run.run_keyRequired if run is setA unique key to differentiate runs with the same name.
run.tagsOptionalTags associated with the Run. Cannot contain spaces.
map_bucket_to_tagOptionalRenames the Influx bucket tag key. By default, the bucket is added using the key "bucket".
omit_bucketOptionalIf true, removes the bucket from the Influx tags. Default is false.
asset_source_tagsRequiredThe Influx tags used to construct the asset name. Tag values are joined with an underscore in the order listed. Use "bucket" (or the renamed key) to include the bucket in the asset name.

​
How Influx data maps to Sift

  • The Influx measure maps to the Sift channel component.
  • Influx tags that are not used to construct the asset name become part of the channel component.
  • Each Influx field becomes an individual Sift channel.

​
Example

Given the following Influx line protocol sent to the CA bucket: 
readings,name=truck_0,fleet=West,model=G-2000,device_version=v2.3 latitude=88.177,longitude=168.95208,elevation=420,velocity=22,heading=61 1451692700000000000
And the following configuration object: 
{
  "run": {
    "name": "vehicle stats",
    "key": "372f7888-ad93-4189-b577-1644ca503413"
  },
  "asset_source_tags": ["fleet", "bucket", "name"]
}
Sift generates the following channels: 
asset:     "West_CA_truck_0"
component: "readings(device_version:v2.3)(model:G-2000)"
timestamp: "2023-08-09T15:24:15+00:00"
Channel nameValue
latitude88.177
longitude168.95208
elevation420
velocity22
heading61
The asset name West_CA_truck_0 is constructed from the fleet, bucket, and name tag values joined with underscores, in the order listed in asset_source_tags. The tags model and device_version are not in asset_source_tags, so they become part of the channel component.