RODEO

Sensors Resource

Sensor reading submission and retrieval

const sensors = rodeo.sensors;

report(input)

Submit a single reading.

await rodeo.sensors.report({
  sensorId: "twilio-delivery",
  beatId: "beat-uuid",
  sceneId: "scene-uuid",
  type: "delivery",
  metric: "delivered",
  value: true,
  confidence: 1.0,
});
FieldTypeRequiredDescription
sensorIdstringYesSensor source identifier
beatIdstringYesBeat UUID
sceneIdstringYesScene UUID
typestringYesdelivery, engagement, response, behavior, sentiment, conversion
metricstringYesWhat was measured
valueunknownYesThe measurement
confidencenumberNo0.0--1.0, default 1.0

reportBatch(inputs)

Submit multiple readings.

await rodeo.sensors.reportBatch([
  {
    sensorId: "twilio-delivery",
    beatId: "beat-1-uuid",
    sceneId: "scene-uuid",
    type: "delivery",
    metric: "delivered",
    value: true,
  },
  {
    sensorId: "email-tracker",
    beatId: "beat-2-uuid",
    sceneId: "scene-uuid",
    type: "engagement",
    metric: "opened",
    value: true,
    confidence: 0.85,
  },
]);

forScene(sceneId, filters?)

const readings = await rodeo.sensors.forScene("scene-uuid", {
  type: "delivery",
  metric: "delivered",
});

Also included in scenes.get() responses.