Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sensorup.com/llms.txt

Use this file to discover all available pages before exploring further.

This model represents the parent-level Emission Event. An event is a container that groups one or more related Emission Observation records into a single, cohesive incident. It is used to track the event’s overall duration, status, root cause, and total impact. Naming Convention: The prefix ee_ is consistently used to denote that these fields belong to the Emission Event entity.

Field Documentation

  • Description: The unique, system-generated primary key for each emission event record.
  • Data Type: UUID or Integer
  • Example: f1a2b3c4-d5e6-4567-8901-234567abcdef
  • Description: A concise, human-readable identifier for the event, used for quick reference in reports and UI.
  • Data Type: String
  • Example: EVT-2025-00451
  • Description: The current workflow status of the overall emission event.
  • Data Type: Enum / String
  • Notes: Enum: ['Open', 'In Progress', 'Closed', 'False Alarm']
  • Description: An array of system-generated reasons that contribute to the current status of the emission event. These provide detailed context for why an event has a particular status.
  • Data Type: Array of String
  • Notes: Enum values: ['MISSING_START_TIME', 'MISSING_END_TIME', 'MISSING_SUB_SITE_ATTRIBUTION', 'CONTAINS_ALARM_ID', 'AUTO_CLOSED_OGI_OBSERVATION', 'HAS_WORK_ITEMS']
  • Example: ["MISSING_START_TIME", "HAS_WORK_ITEMS"]
  • Description: A free-text field that allows users to provide additional context when manually changing the status of an emission event. This field captures user-provided reasoning for status transitions.
  • Data Type: String (Text)
  • Example: "Status updated to Closed after confirming repair completion and post-repair inspection"
  • Description: A flag used for soft-deleting records. If true, the event is considered deleted and should not appear in standard queries.
  • Data Type: Boolean
  • Example: false
  • Description: The top-level asset from the customer’s asset hierarchy. This is determined by taking the eo_assetReference from a child Emission Observation and traversing up the hierarchy to the top-most parent asset.
  • Data Type: String
  • Notes: Foreign Key to an ‘Assets’ table, representing the root asset for the event.
  • Description: A direct copy of the eo_sourceAssetReference from the underlying child Emission Observation. This represents the most granular source identified at the time of ingestion.
  • Data Type: String
  • Notes: Foreign Key to an ‘Assets’ or ‘Components’ table.
  • Description: The earliest detection timestamp from all the child Emission Observations linked to this event.
  • Data Type: Timestamp (ISO 8601)
  • Example: 2025-06-22T08:30:00Z
  • Description: The official start time of the entire emission event. This value is derived from the start times of the underlying child Emission Observations, based on a customer-configured priority of detection types. This logic is used for reconciliation and reporting.
  • Data Type: Timestamp (ISO 8601)
  • Example: 2025-06-22T08:25:00Z
  • Description: A flag to denote the origin of the start time. true indicates the ee_startTime was populated from an actual start time of an underlying Emission Observation. false indicates the time was estimated from other data (e.g., non-detects, default values) to set a duration.
  • Data Type: Boolean
  • Example: false
  • Description: The official end time of the entire emission event, which may be null if ongoing. This value is derived from the end times of the underlying child Emission Observations, based on a customer-configured priority of detection types.
  • Data Type: Timestamp (ISO 8601)
  • Example: null
  • Description: A flag to denote the origin of the end time. true indicates the ee_endTime was populated from an actual end time of an underlying Emission Observation. false indicates the time was estimated or defaulted.
  • Data Type: Boolean
  • Example: false
  • Description: The official emissions rate for the event, used for reporting. This value is derived from the rates of the underlying child Emission Observations, based on a customer-configured priority of detection types.
  • Data Type: Float or Decimal
  • Notes: Units (e.g., kg/hr, scfh) must be standardized.
  • Description: The calculated total volume or mass of emissions for the duration of the event.
  • Data Type: Float or Decimal
  • Notes: Units (e.g., kg, scf) must be standardized. Calculated from rate and duration.
  • Description: The high-level category of the emission source, typically assigned during investigation.
  • Data Type: Enum / String
  • Notes: Recommended Enum: ['Fugitive', 'Vented', 'Combustion', 'Equipment Malfunction', 'Planned Maintenance']
  • Description: The specific root cause of the emission.
  • Data Type: Enum / String
  • Notes: Recommended Enum: ['Component Failure', 'Worn Seal', 'Improper Procedure', 'Upset Condition', 'Scheduled Blowdown']
  • Description: A free-text field for a detailed explanation of the event’s root cause, investigation findings, and actions taken.
  • Data Type: String (Text)
  • Description: A field to credit the team, individual, or system responsible for identifying the root cause of the event.
  • Data Type: String
  • Example: "LDAR Team B", "Analytics Model #4"
  • Description: These fields provide a summary count of all child Emission Observations linked to this event, broken down by their detection type.
  • Data Type: Integer
  • Fields:
    • ee_observationCountsCMS: Continuous Monitoring System
    • ee_observationCountsFLY: Flyover / Aerial Survey
    • ee_observationCountsSAT: Satellite
    • ee_observationCountsOGI: Optical Gas Imaging
    • ee_observationCountsMNL: Manual Entry / Operator Sighting
    • ee_observationCountsVFB: Venting, Flaring, or Blowdown (Operational Event)
    • ee_observationCountsDRN: Drone
    • ee_observationCountsOWD: Operator Walk-down
    • ee_observationCountsEME: Emergency System Alert
    • ee_observationCountsNOD: No Detection (e.g., from a scheduled inspection that found nothing)
    • ee_observationCountsUNK: Unknown
  • Description: The identifier for the tenant (customer) in the SensorUp system that this emission event belongs to.
  • Data Type: String
  • Example: "customer-acme-inc", "9e8b1b0e-a2f0-4a8a-a2b8-9d5d852673c6"