Introduction
The Data Catalogue HTTP API allows you to fetch data stored in the Quix platform. You can use it for exploring the platform, prototyping applications, or working with stored data in any language with HTTP capabilities.
The API is fully described in our Swagger documentation. Read on for a guide to using the API, including real-world examples you can invoke from your language of choice, or using the command line using curl
.
Preparation
Before using any of the endpoints, you’ll need to know how to authenticate your requests and how to form a typical request to the API.
You’ll also need to have some data stored in the Quix platform for API use to be meaningful. You can use any Source from our Code Samples to do this using the Quix portal.
Further documentation
Documentation | Endpoint | Examples |
---|---|---|
Streams, paged | /streams |
Get all streams in groups of ten per page |
Streams, filtered | /streams |
Get a single stream, by ID |
Get only the streams with LapNumber data | ||
Streams & models | /streams/models |
Get stream hierarchy |
Raw data | /parameters/data |
Get all the Speed readings |
Get Speed data between timestamps |
||
Aggregated data by time | /parameters/data |
Downsample or upsample data |
Aggregated by tags | /parameters/data |
Show average Speed by LapNumber |
Tag filtering | /parameters/data |
Get data for just one Lap |