BLbluestaq
Sensor

POST /udl/sensormetrics

Changed on

Service operation to take a single SensorMetrics as a POST body and ingest into the database. A specific role is required to perform this service operation. Please contact the UDL team for assistance.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/sensormetrics
  • Auth
    none declared

Request body

idstring

Unique identifier of the record, auto-generated by the system.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

startTimestring date-time required

The start time of the observation window, in ISO 8601 UTC format with millisecond precision.

durationinteger

The duration of the observation window for this data record, in days.

idSensorstring

Unique identifier of the sensor from which the signature data applied in this assessment was collected. This ID can be used to obtain additional information on a sensor using the 'get by ID' operation (e.g. /udl/sensor/{id}). For example, the sensor with idSensor = abc would be queried as /udl/sensor/abc.

origSensorIdstring

Optional identifier provided by the observation source to indicate the sensor which produced these observations. This may be an internal identifier and not necessarily a valid sensor ID.

idSitestring

Unique identifier of the site associated with the sensor(s) referenced in this record. This ID can be used to obtain additional information on a site using the 'get by ID' operation (e.g. /udl/site/{id}). For example, the site with idSite = abc would be queried as /udl/site/abc.

origSiteIdstring

Optional identifier provided by the observation source to indicate the site from which these observations originated. This may be an internal identifier and not necessarily a valid site ID.

sensorNetworkstring

Identifies the network or grouping of sensors associated with the site that collectively contributed to these observations when this record represents more than one sensor.

aggregationTypestring

Indicates whether the object count metrics are computed for a single sensor pairing or for a group of sensors. Use PAIRED when this record represents a single sensor. These metrics are for the sensor that paired with that sensor to track the most or second-most near-unique objects. Use GROUP when this record represents a group of sensors. These metrics are for the sensor in that group that tracked the most and second-most total objects.

avgUptimenumber double

Average percentage of time per day the sensor or site is available for tasking, taking into account outages for weather, maintenance, and any other reasons. Values are between 0.0 and 100.0.

avgMaxNumTracksnumber double

Average maximum number of tracks per hour based on performance statistics. This should not be interpreted as a capacity limit, as it combines sensor constraints and tasking; rather, it is a rough estimate of the number of trackable objects.

cadencenumber double

Rate at which the sensor transmits data, in minutes.

avgLatencynumber double

Average delay between observation collection and data transmission, in minutes.

latencySigmanumber double

Standard deviation of the delay between observation collection and data transmission, in minutes.

tagsstring[]

Optional array of provider/source specific tags for this data, where each element is no longer than 32 characters, used for implementing data owner conditional access controls to restrict access to the data. Should be left null by data providers unless conditional access controls are coordinated with the UDL team.

transactionIdstring

Optional identifier to track a commercial or marketplace transaction executed to produce this data.

createdAtstring date-time

Time the row was created in the database, auto-populated by the system.

createdBystring

Application user who created the row in the database, auto-populated by the system.

sourcestring required

Source of the data.

sourceDLstring

The source data library from which this record was received. This could be a remote or tactical UDL or another data library. If null, the record should be assumed to have originated from the primary Enterprise UDL.

originstring

Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.

dataMode'REAL' | 'TEST' | 'EXERCISE' | 'SIMULATED' required

Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data:

REAL: Data collected or produced that pertains to real-world objects, events, and analysis.

TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics.

EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data.

SIMULATED: Synthetic data generated by a model to mimic real-world datasets.

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

Example request

{
  "id": "026dd511-8ba5-47d3-9909-836149f87686",
  "classificationMarking": "U",
  "startTime": "2026-01-01T00:00:00.123Z",
  "duration": 30,
  "idSensor": "SENSOR-ID",
  "origSensorId": "ORIG-SENSOR-ID",
  "idSite": "SITE-ID",
  "origSiteId": "ORIG-SITE-ID",
  "sensorNetwork": "SSN",
  "aggregationType": "PAIRED",
  "avgUptime": 79.1,
  "avgMaxNumTracks": 100.1,
  "cadence": 10.23,
  "avgLatency": 10.23,
  "latencySigma": 10.23,
  "tags": [
    "TAG1",
    "TAG2"
  ],
  "transactionId": "TRANSACTION-ID",
  "sensorMetricsTrackedElement": [
    {
      "id": "026dd511-8ba5-47d3-9909-836149f87686",
      "classificationMarking": "U",
      "idSensorMetrics": "SENSORMETRICS-ID",
      "element": "OBJECT",
      "elementType": "ANALYST",
      "uniqueness": "UNIQUE",
      "elementOrbitType": "NE",
      "numElements": 13,
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "sourceDL": "AXE",
      "source": "Bluestaq",
      "origin": "THIRD_PARTY_DATASOURCE",
      "origNetwork": "OPS1",
      "dataMode": "TEST"
    }
  ],
  "sensorMetricsTrackedAggregate": [
    {
      "id": "026dd511-8ba5-47d3-9909-836149f87686",
      "classificationMarking": "U",
      "idSensorMetrics": "SENSORMETRICS-ID",
      "idSensorAgg": "SENSORAGG-ID",
      "origSensorAggId": "ORIG-SENSORAGG-ID",
      "trackingRank": 1,
      "objectType": "ANALYST",
      "orbitType": "NE",
      "objectCount": 769,
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "sourceDL": "AXE",
      "source": "Bluestaq",
      "origin": "THIRD_PARTY_DATASOURCE",
      "origNetwork": "OPS1",
      "dataMode": "TEST"
    }
  ],
  "sensorMetricsTasking": [
    {
      "id": "026dd511-8ba5-47d3-9909-836149f87686",
      "classificationMarking": "U",
      "idSensorMetrics": "SENSORMETRICS-ID",
      "taskingSource": "CATALOGED",
      "taskingElement": "OBJECT",
      "taskingMetric": "TASKED",
      "category": "1",
      "metricCount": 5,
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "sourceDL": "AXE",
      "source": "Bluestaq",
      "origin": "THIRD_PARTY_DATASOURCE",
      "origNetwork": "OPS1",
      "dataMode": "TEST"
    }
  ],
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "source": "Bluestaq",
  "sourceDL": "AXE",
  "origin": "THIRD_PARTY_DATASOURCE",
  "dataMode": "TEST",
  "origNetwork": "OPS1"
}

Response

Success

Changes

Some revisions have not been checked yet.