Data API
Performaar's Data API is a subset of the GraphQL API that offers a format-agnostic method of accessing recorded data, be it DIS, HLA, MAVLink or any other supported data type.
The Data API can be accessed using the data query on the GraphQL endpoint (see Usage for more details).
When provided with the path to a Recording's debrief.yaml file the query will return a list of entities and common
properties for each entity, like position, orientation, relevant events and so on. Each property can then be queried in
a variety of units and, where relevant, coordinate systems.
Finally, the Data API also provides a highly flexible system of filtering and aggregating data which can be used to derive metrics using the raw data available. Potential use cases include:
- Building your own user interface using data recorded by Performaar.
- Generating reports tailored to your specific needs.
- Feeding recorded data into your own AI and machine learning models for training.
- Integrating with a Learning Management System to track and record performance.
- Exporting data into whatever file formats your existing tools and workflows require.
Like with the rest of the GraphQL API, a detailed reference documentation for the Data API can be found in the GraphiQL playground embedded into Performaar at /api/graphql.