Integrations: API

Do you have important metrics from one or more applications or systems that you need to visualize and/or monitor? You can easily get those metrics into metricboard.io via the API

The API is optimized for easy and fast integration. No need for special agents or libraries, all you need is a simple post request from your application backend.

Tip: Need counters?

There are 2 types of metrics supported in metricboard.io feeds: plain metrics and counters.

Use plain metrics to send data on a repeating interval. For example: send the total number of completed orders and active customers from your backend every hour.

Counters can be used to track "live" metrics. For example: increase the number of logged in users with 1 every time a user logs in successfully.

For counters use a + in front of the metric name,
for example: "+logins"

Send data using the metricboard.io API

Step 1: Create a feed

Data in metricboard.io is collected into feeds. Feeds are then used by dashboards and monitor to visualize the data and perform alerting.

Each feed has a separate API key which you use to send data to a specific feed.

Start by navigating to the account tab and then click New feed.

Enter a name for the feed and create a new feed.

Step 2: Send data to the feed

As soon as you create the feed a popup will be shown with everything you need to send actual data.

Use the API instructions to send data from your own platform by using a POST request.

You can also use the ready-to-go code examples to get started quickly.

Send metrics simply as POST requests, where field names are the metric names and field values the metric numerical values:

  • Method: POST
  • URL: https://metricboard.io/api/metric
  • Header: apikey: the API key for the feed you just created
  • Body: (application/x-www-form-urlencoded or application/json encoded)
    • metric name a: metric value a
    • another metric b: metric value b

For example, as a WGET request:

wget https://metricboard.io/api/metric --post-data="metric_1=42&metric_2=12" --header "apikey: XXX"

Optionally you can send a header ts with a unix timestamp to explicitly set the date and time for the values.

Step 2: That's it ...

As soon as you start to send data you should see it arrive in the feed.

Now you can open the dashboards or monitors tab and start to visualize and monitor the incoming data.