The contents of this page have been optimised for wider screens. For the best learning experience, please change to a wider display.

Practical step-by-step instructions to using FestApi

Below you will find step-by-step instructions on how to use FestApi to fetch and visualize data from an API and, if you don't have an API, how to stream keyboard input data. Click the instruction boxes on the left to explore.

If you need more help, do not hesitate to email us or submit a ticket thorugh the app.

Visualize data from an API

Create beautiful visualizations of an API with just a few clicks and improve reach.
Currently FestApi supports five types of charts.

1. Open API Explorer

Click API Explorer at the top of the page.

2. Enter the URL of the API of interest

Find an API of interest or use your own. In this example we will use air quality data from the Norwegian Meteorological Institute (MET Norway). However, as FestApi is schema-independent, you can use any API you like.

3. Select visualization type

Select the type of visualization you wish to create. In our case, we want to show the data as a timeseries so we choose "Timeseries" from the dropdown menu.

4. Answer a few questions

Answer the point-and-click questions regarding the sctructure of your API schema and a few others, mostly data type specific questions presented by the API Explorer. Also, choose whether to allow visitors to embed or customize the chart or download the displayed data into a CSV file, and give your visualization a name and an optional title.

5. Style your visualization (premium feature)

Customize the visualization to your liking using our visual editing interface. You can also choose to disable other ready-made themes available to visitors by default.

6. Ready to embed & share

Let FestApi work its magic and click the instantaneously available visualization open from the appearing link under the Name-column. This link points to a webpage with your visualization, wrapped in a user interface that enables embedding.

7. See for yourself what your users experience

Here visitors will find the HTML code snippet for embedding your visualization. Clicking the clipboard icon will copy it to your clipboard. They can also customize the style of the visualization to fit their needs with the size and theme inputs below the snippet.

8. Get the ball rolling!

When embedded, the < embed > icon in the bottom-right corner of the visualization will direct users to this view. So, to begin introducing your visualization to an ever-growing audience, you can either embed the visualization on your website, or copy the URL from the address bar and share it with anyone.

Image missing!

Stream and visualize real-time data input

If you do not have an API, but do have data that you want to introduce to a wider audience,
you can start streaming data with simple keyboard input and have it hosted by us.

1. Click Open Stream

Click Open Stream at the top of the page.

2. Configure your stream

Select the type of your data, an input method that fits your use case, and a few mostly type-specific configurations. Also, choose whether to allow embedding or customizing the chart or downloading the data into a CSV file, and give your visualization an optional title and name, and hit Deploy (after optionally customizing the chart styles in the next step).

3. Style your visualization (premium feature)

Style your visualization as you like. The data shown is illustrative for the purpose of helping you to see what the finished visualization would look like with real data.

4. Ready to input data

The input panel opens automatically.

5. Start streaming

Type in your inputs and hit enter. When you are done, close the input panel by clicking anywhere outside of it. Later, whenever you want to make new entries, simply reopen the input panel by clicking on the Make entries button of your stream (plus sign within square) in the main view. The stream visualization seen by users will update in real-time.

6. Ready to embed & share

Click the stream visualization open from the link under the Name-column. This link points to a webpage with your stream visualization, wrapped in a user interface that enables embedding.

7. See for yourself what your users experience

Here visitors will find the HTML code snippet for embedding your visualization. Clicking the clipboard icon will copy it to your clipboard. They can also customize the style of the visualization to fit their needs with the size and theme inputs below the snippet.

8. Get the ball rolling!

When embedded, the < embed > icon in the bottom-right corner of the visualization will direct users to this view. So, to begin introducing your visualization to an ever-growing audience, you can either embed the visualization on your website, or copy the URL from the address bar and share it with anyone.

Image missing!