Skip to content
On this page

Quick Start

Getting started with Netzo is simple. This guide will walk you through creating an account and exploring its main features for you to get to know the platform. We will skip over lengthy, technical descriptions for now. The goal here is to get you up and running quickly.

Create an account

  1. Head over to app.netzo.io and sign up to create a new account.
  2. Click on the newly created workspace to navigate into it.

Design your first dashboard

To create your first dashboard:

  1. Head over to the Dashboards page and click the Create button.
  2. Open-up the context drawer, head to the components tab and start dragging-and-dropping components.
  3. Create a dashboard query to display some data in the components.
  4. Select the component you recently drag-and-dropped, and use the Value field to display the information as you see fit.

INFO

Accessing dynamic state To access the dashboard's dynamic state you can use template literals e.g. ${myQuery.data}

Your Dashboard is ready. Be sure to save it before exiting.

Start using the Netzo API

Interacting with the Netzo HTTP API requires a valid API key. Feel free to skip this step if you don't plan on interacting with Netzo via the HTTP API. You can always come back later.

  1. Create an API key by navigating into Workspace Settings > API Keys and clicking on Create

  2. Start using the Netzo API by sending HTTP requests to any valid Resource endpoint by passing the API key from above in either:

    • In 'x-api-key' header for example { 'x-api-key': API_KEY } (recommended)
    curl -H "x-api-key: API_KEY" https://api.netzo.io/RESOURCE
    
    fetch('https://api.netzo.io/RESOURCE', {
      headers: { 'x-api-key': 'API_KEY' },
    })
    
    • In apiKey query parameter for example /RESOURCE?apiKey=${API_KEY}
    curl -H "Content-Type: application/json" -X GET https://api.netzo.io/RESOURCE?apiKey=API_KEY
    
    fetch('https://api.netzo.io/RESOURCE?apiKey=API_KEY')
    
Quick Start has loaded