API Data Formats & Output Targets

The API Data Formats & Output Targets editor allows you to edit the data that is exposed for your project via the Quuppa API. The basic formats available for customisations include:

  • DefaultInfo - This format provides all of the API commands for data related to tag information such as tag state, tag group, battery level, button state, acceleration data, TX power, developer specific data. Both JSON and CSV outputs are available. The format is for cases where you only require information about the tags in the project, e.g. an application for monitoring the battery levels and current states of the tags in a project.
  • DefaultLocation - This format provides all of the API commands for data related to the positioning information, such as location estimates, the coordinate systems, the tracking areas and zones. Both JSON and CSV outputs are available. The format is for cases where you want to show the positioning information related to the project, e.g. applications that visualise how tags move around a space on a map.
  • DefaultLocationAndInfo - This format provides a combination of tag information (e.g. tag states, tag groups, battery level, button state, acceleration data, TX power and developer specific data) and positioning information (e.g. location estimates, coordinate systems, tracking areas and zones). Both JSON and CSV outputs are available. This format is for cases that require both types of data, e.g. applications where tag movements are shown on a map and actions triggered by pressing the tag button are also visualised in the map view.
  • ALL_ITEMS - This format provides all of the available Quuppa API commands in the same format. Both JSON and CSV outputs are available. This format is not intended for use as is, but provides all of the possible options to enable format customisations according to the needs of your project.
Note: If you have enabled Legacy Output Formats from the QSP application settings, you will also be able to see the following legacy formats: Location JSON, Location CVS, Tag info JSON, Tag info CSV, Processed location CSV. These legacy formats are deprecated, please use the default formats listed above instead.

The following section includes descriptions for the different positioning data filters, the basic ways to customising the formats for the needs of your project as well as how to create output targets. For more information on using the Quuppa API, please refer to the Quuppa API documentation, available via links in the Quuppa Positioning Engine (QPE) Web Console.