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 is designed to capture all relevant information about a single, detected emission event. It tracks the event from initial detection through compliance and resolution, linking it to specific assets and supporting media. Naming Convention: The prefix eo_ is consistently used to denote that these fields belong to the Emission Observation entity.

Field Documentation

  • Description: The unique, system-generated primary key for each emission observation record.
  • Data Type: UUID or Integer
  • Deprecated: No
  • Example: a1b2c3d4-e5f6-7890-1234-567890abcdef
  • Description: A concise, human-readable identifier for the observation, often used for quick reference in reports and UI.
  • Data Type: String
  • Deprecated: No
  • Example: OBS-2025-00123
  • Description: A reference to the asset associated with the emission. This link is either provided directly by a third-party data source or is programmatically inferred by the SensorUp platform based on the geographical proximity of the emission to a known asset during data ingestion.
  • Data Type: String
  • Deprecated: No
  • Notes: Foreign Key to an ‘Assets’ table. Can be an ID or name.
  • Description: A reference to the most finite (granular) source of the emission as provided during data ingestion. This is often a specific piece of equipment, component, or instrument identified by a third-party data source.
  • Data Type: String
  • Deprecated: No
  • Notes: Foreign Key to an ‘Assets’ or ‘Components’ table.
  • Description: An identifier that links this observation to a broader screening or inspection event.
  • Data Type: String or Integer
  • Deprecated: No
  • Notes: Foreign Key, likely referencing a ‘Screening Events’ table.
  • Description: The exact date and time when the emission was first detected by the source asset.
  • Data Type: Timestamp (ISO 8601)
  • Deprecated: No
  • Example: 2025-06-23T10:15:00Z
  • Description: The official start time of the emission event being observed.
  • Data Type: Timestamp (ISO 8601)
  • Deprecated: No
  • Example: 2025-06-23T10:14:30Z
  • Description: The official end time of the emission event. This may be null if the emission is ongoing.
  • Data Type: Timestamp (ISO 8601)
  • Deprecated: No
  • Example: 2025-06-23T11:05:00Z or null
  • Description: The method or technology used to detect the emission.
  • Data Type: Enum / String
  • Deprecated: No
  • Notes: Recommended Enum: ['OGI', 'Sensor', 'Aerial', 'Manual', 'Auditory']
  • Description: Describes how the observation data was entered into the system.
  • Data Type: Enum / String
  • Deprecated: No
  • Notes: Recommended Enum: ['Automated Feed', 'Manual Entry', 'File Upload']
  • Description: A descriptive name for the specific source of the detection (e.g., a sensor ID or operator’s name).
  • Data Type: String
  • Deprecated: No
  • Example: "Drone #A42-ZULU", "Sensor #GH-5501"
  • Description: The quantified rate of the emission. Units should be standardized across the system.
  • Data Type: Float or Decimal
  • Deprecated: No
  • Example: 15.75 (Units like kg/hr or scfh should be explicit).
  • Description: The current workflow status of the emission observation.
  • Data Type: Enum / String
  • Deprecated: No
  • Notes: Recommended Enum: ['New', 'Investigating', 'Resolved', 'Closed']
  • Description: The user ID or process that created the record in the system.
  • Data Type: String or Integer
  • Deprecated: No
  • Notes: Foreign Key to a ‘Users’ table or system process name.
  • Description: The timestamp of when this observation record was created in the system.
  • Data Type: Timestamp (ISO 8601)
  • Deprecated: No
  • Example: 2025-06-23T14:35:00Z
  • Description: The last user or process that updated this record.
  • Data Type: String or Integer
  • Deprecated: No
  • Notes: Foreign Key to a ‘Users’ table.
  • Description: The timestamp of the most recent update made to this record.
  • Data Type: Timestamp (ISO 8601)
  • Deprecated: No
  • Example: 2025-06-23T14:35:00Z
  • Description: A list of Uniform Resource Locators (URLs) pointing to supporting media files (e.g., images, videos) stored in an AWS S3 bucket.
  • Data Type: Array of String (URL)
  • Deprecated: No
  • Example: ["https://.../img1.jpg", "https://.../vid1.mp4"]
  • Description: An identifier used to group multiple, related observations into a single overarching emission event.
  • Data Type: String or Integer
  • Deprecated: No
  • Example: EVT-LEAK-558

Deprecated Fields

The following fields are deprecated and should not be used for new development. They are maintained for historical data purposes only.
  • Description: The timestamp of the most recent compliance-related action taken for this observation.
  • Data Type: Timestamp (ISO 8601)
  • Deprecated: Yes
  • Description: The regulatory or internal deadline by which compliance actions must be completed for this observation.
  • Data Type: Date or Timestamp
  • Deprecated: Yes
  • Description: A flag indicating whether a user has officially reviewed and acknowledged the observation.
  • Data Type: Boolean
  • Deprecated: Yes
  • Description: The specific name or identifier of the equipment component associated with the emission.
  • Data Type: String
  • Deprecated: Yes
  • Description: The user ID or name of the person who acknowledged the emission observation.
  • Data Type: String or Integer
  • Deprecated: Yes
  • Description: The date and time when the observation was acknowledged by a user.
  • Data Type: Timestamp (ISO 8601)
  • Deprecated: Yes