REST API Reference

This document provides a comprehensive reference for all endpoints available in the Dashboard.PT API. Each section describes the available operations for a specific resource type.

Dashboards API

The Dashboards API allows you to manage your dashboard containers.

Endpoint Method Description
/api/dashboards GET List all dashboards
/api/dashboards POST Create a new dashboard
/api/dashboards/{id} GET Get a specific dashboard
/api/dashboards/{id} PUT Update a dashboard
/api/dashboards/{id} DELETE Delete a dashboard
/api/dashboards/{id}/graphs GET List graphs in a dashboard

Create Dashboard

Request body example:

{
  "name": "Sales Dashboard",
  "description": "Monthly sales performance tracking",
  "is_public": false
}

Graphs API

The Graphs API allows you to manage visualizations within dashboards.

Endpoint Method Description
/api/graphs GET List all graphs
/api/graphs POST Create a new graph
/api/graphs/{id} GET Get a specific graph
/api/graphs/{id} PUT Update a graph
/api/graphs/{id} DELETE Delete a graph

Create Graph

Request body example:

{
  "dashboard_id": 123,
  "name": "Monthly Sales",
  "type": "line",
  "source_id": 456,
  "config": {
    "theme": "light",
    "title": "Monthly Sales Trends",
    "xAxis": {
      "title": "Month"
    },
    "yAxis": {
      "title": "Revenue (€)",
      "min": 0
    },
    "legend": true,
    "animation": true,
    "updateFrequency": "daily"
  },
  "is_public": false
}

Data Points API

The Data Points API allows you to add and retrieve data for graphs.

Endpoint Method Description
/api/data-points POST Add data points to a graph
/api/data-points/{graph_id} GET Get data points for a graph
/api/data-points/{graph_id} DELETE Delete all data points for a graph

Add Data Points

Request body example:

{
  "graph_id": 123,
  "data": [
    {
      "timestamp": "2023-06-15 14:30:00",
      "value": 42.5,
      "label": "June Sales"
    },
    {
      "timestamp": "2023-07-15 14:30:00",
      "value": 47.8,
      "label": "July Sales"
    }
  ]
}

Update Frequency

Adding data points is subject to the graph's updateFrequency setting. See Graph Update Frequency for details.

Data Sources API

The Data Sources API allows you to manage connections to data providers.

Endpoint Method Description
/api/data-sources GET List all data sources
/api/data-sources POST Create a new data source
/api/data-sources/{id} GET Get a specific data source
/api/data-sources/{id} PUT Update a data source
/api/data-sources/{id} DELETE Delete a data source

API Keys

The API Keys endpoint allows you to manage your API access tokens.

Endpoint Method Description
/api/api-keys GET List all API keys
/api/api-keys POST Create a new API key
/api/api-keys/{id} DELETE Delete an API key

Want to try it? The free plan has no time limit.

Create a free account