Referência da API REST
Este documento fornece uma referência completa de todos os endpoints disponíveis na API do Dashboard.PT. Cada secção descreve as operações disponíveis para um tipo de recurso específico.
API de Dashboards
A API de Dashboards permite-te gerir os teus contentores de dashboard.
| Endpoint | Method | Descrição |
|---|---|---|
| /api/dashboards | GET | Listar todos os dashboards |
| /api/dashboards | POST | Criar um novo dashboard |
| /api/dashboards/{id} | GET | Obter um dashboard específico |
| /api/dashboards/{id} | PUT | Atualizar um dashboard |
| /api/dashboards/{id} | DELETE | Eliminar um dashboard |
| /api/dashboards/{id}/graphs | GET | Listar os gráficos de um dashboard |
Criar Dashboard
Exemplo de corpo do pedido:
"name": "Sales Dashboard",
"description": "Monthly sales performance tracking",
"is_public": false
}
API de Gráficos
A API de Gráficos permite-te gerir as visualizações dentro dos dashboards.
| Endpoint | Method | Descrição |
|---|---|---|
| /api/graphs | GET | Listar todos os gráficos |
| /api/graphs | POST | Criar um novo gráfico |
| /api/graphs/{id} | GET | Obter um gráfico específico |
| /api/graphs/{id} | PUT | Atualizar um gráfico |
| /api/graphs/{id} | DELETE | Eliminar um gráfico |
Criar Gráfico
Exemplo de corpo do pedido:
"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
}
API de Pontos de Dados
A API de Pontos de Dados permite-te adicionar e obter dados para os gráficos.
| Endpoint | Method | Descrição |
|---|---|---|
| /api/data-points | POST | Adicionar pontos de dados a um gráfico |
| /api/data-points/{graph_id} | GET | Obter os pontos de dados de um gráfico |
| /api/data-points/{graph_id} | DELETE | Eliminar todos os pontos de dados de um gráfico |
Adicionar Pontos de Dados
Exemplo de corpo do pedido:
"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"
}
]
}
Frequência de Atualização
A adição de pontos de dados está sujeita à definição updateFrequency do gráfico. Consulta Frequência de Atualização do Gráfico para mais detalhes.
API de Fontes de Dados
A API de Fontes de Dados permite-te gerir as ligações a fornecedores de dados.
| Endpoint | Method | Descrição |
|---|---|---|
| /api/data-sources | GET | Listar todas as fontes de dados |
| /api/data-sources | POST | Criar uma nova fonte de dados |
| /api/data-sources/{id} | GET | Obter uma fonte de dados específica |
| /api/data-sources/{id} | PUT | Atualizar uma fonte de dados |
| /api/data-sources/{id} | DELETE | Eliminar uma fonte de dados |
Chaves de API
O endpoint de Chaves de API permite-te gerir os teus tokens de acesso à API.
| Endpoint | Method | Descrição |
|---|---|---|
| /api/api-keys | GET | Listar todas as chaves de API |
| /api/api-keys | POST | Criar uma nova chave de API |
| /api/api-keys/{id} | DELETE | Eliminar uma chave de API |
Quer experimentar? O plano gratuito não tem limite de tempo.
Criar conta gratuita