Quick Start: Fetch data from the Data Catalogue

Aim

This guide will take you through the steps to start using the Quix Data Catalogue API. The API gives access to data persisted in the Quix Platform, so it’s good for exploring the data model and working with simple prototypes.

By the end you will have:

  • Discovered how to obtain sample code from our library

  • Used the Data Catalogue API to fetch data stored in the Quix platform

Before you begin

  • You’ll need to have streamed some data into a persisted topic in order to retrieve it. If you haven’t already done so, you can follow our Quick Start to streaming data.

  • You’ll need to have the command line program curl installed. It is available for many different systems, including Linux, macOS, and Windows.

Overview

This walkthrough covers the following steps:

  1. Get sample code

  2. Run sample code on the command line

Get sample code

The easiest way to fetch data from the catalogue is to run our sample code. This is configured for your environment and will demonstrate how to connect and use the API. Once you are comfortable with this process, you can explore the sample code and use it to develop your own projects.

  1. Click the Data icon data icon in the left-hand menu.

  2. Locate the “cardata” stream from the “cars” topic created in the previous Quick Start.

  3. Hover over the stream and click the “Visualize” icon. visualize icon.

  4. On the Visualize page, click the SELECT button alongside “Parameters” and select Gear, then click DONE.

  5. Click the CONNECT button on the top-right of the waveform.

  6. Make sure that the “Select code language” drop-down is set to the “Shell” option.

You should now see the sample project code displayed in the main text box.

data catalogue sample

Run sample code on the command line

Finally, it’s time to run the sample code.

  1. Copy the sample code and paste it onto your command line.

  2. Once executed, you should see JSON output representing data queried from the catalogue.

data catalogue curl
You can pipe the output into a tool like jq for a nicely-formatted response, and to quickly query the response further.

The capabilities of the Data Catalogue API are explained further in our How To guides.