24SEA Data API Endpoints

 

The 24SEA Data API is a RESTful API that provides access to 24SEA SHM data. The API is designed to be simple and easy to use, and it is based on the OpenAPI 3 specification.

The API is organized in apps, each of them provides access to a specific set of data.

Datasignals

10-minute metric signals that are collected by the 24SEA SHM system. The 10-minute metric signals (from now on addressed as metrics) are the cleaned and aggregated data calculated on a 10-minute basis.

The metrics are calculated from the high-frequency raw data collected by the 24SEA SHM system. 24SEA does not provide direct access to the raw data as it needs to be processed and aggregated to be useful.

We chose 10 minutes as the aggregation period because it has become an industry standard for SHM systems, since it is a good balance between the need for high temporal resolution and the need for a manageable amount of data.

Users can verify which metrics they can access by inspecting their Datasignals App UI.

Annotations

We define as annotation each piece of information that is added to the 24SEA SHM system, such as curtailment events, maintenance operations, natural hazards, start / stop cycles, general comments, and other metadata that cannot be directly derived from the data signals.

Annotations can be added both manually and automatically. Manual annotations are added by users through the 24SEA Data API Annotations App UI, while automatic annotations would be added via API calls, based on predefined rules.

AI

The AI app provides access to the AI models that are available in the 24SEA SHM system. The AI models are used to make predictions based on the data collected by the 24SEA SHM system. The AI predictions are calculated on the fly, based on the datasignals available in the time-window specified by the user.

The AI app is designed to be used by users with AI permissions, which are granted by the system administrators. Users can verify which AI models they can access by querying the /ai/models endpoint.

The AI app also provides endpoints to check user permissions for the provided models, and to get input and output schemas for the provided models.