Access Swagger

You can access documentation and a basic playground for the Data Catalogue API via Swagger. The exact URL is workspace-specific, and follows this pattern:

https://telemetry-query-${organisation}-${workspace}.platform.quix.ai/

The workspace ID is a combination based on your organisation and workspace names. For example, for an "acme" organisation with a "weather" workspace, the final URL might look something like:

https://telemetry-query-acme-weather.platform.quix.ai/

To determine the final URL, you can find out how to get a workspace id, or follow these instructions:

  1. Click the Connect icon connect in the main menu.

  2. Using the "Select code language" drop down on the right of this page, choose "Swagger".

code lang swagger
  1. Click the link to access the Swagger documentation.