Dashboard

Visão Geral

O módulo Dashboard fornece dados agregados e indicadores gerenciais para compor painéis de controle. Retorna quantidades operacionais, organização geográfica de pedidos e evolução mensal de vendas.

Base URL

/api/dashboard

Todos os endpoints requerem autenticação via Bearer Token:
Authorization: Bearer {token}

---

Endpoints

GET /api/dashboard/recuperar-quantidades

Descrição: Retorna contadores gerais do sistema, como total de pedidos, clientes, produtos e outras métricas operacionais do período atual.

Parâmetros

Nenhum.

Resposta de Sucesso 200

{
  "pedidos": 142,
  "clientes": 380,
  "produtos": 1250,
  "notasFiscais": 98,
  "contasPagar": 35,
  "contasReceber": 67
}

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/dashboard/recuperar-quantidades" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/dashboard/recuperar-quantidades', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/dashboard/recuperar-quantidades',
    headers={'Authorization': 'Bearer {token}'}
).json()

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/dashboard/recuperar-quantidades", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/dashboard/recuperar-quantidades');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/dashboard/recuperar-quantidades",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/dashboard/recuperar-quantidades",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

GET /api/dashboard/recuperar-organizacao

Descrição: Retorna a distribuição geográfica dos pedidos por cidade, com o valor total acumulado em cada localidade. Útil para mapas e análises regionais de vendas.

Parâmetros

Nenhum.

Resposta de Sucesso 200

[
  {
    "cidade": "São Paulo",
    "valor": 125000.50
  },
  {
    "cidade": "Campinas",
    "valor": 48300.00
  },
  {
    "cidade": "Ribeirão Preto",
    "valor": 21700.75
  }
]

Campos da Resposta

Campo	Tipo	Descrição
cidade	string	Nome da cidade
valor	number (double)	Valor total dos pedidos na cidade

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/dashboard/recuperar-organizacao" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/dashboard/recuperar-organizacao', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/dashboard/recuperar-organizacao',
    headers={'Authorization': 'Bearer {token}'}
).json()

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/dashboard/recuperar-organizacao", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/dashboard/recuperar-organizacao');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/dashboard/recuperar-organizacao",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/dashboard/recuperar-organizacao",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

GET /api/dashboard/recuperar-pedido-mensal

Descrição: Retorna um array com os valores mensais de pedidos dos últimos 12 meses, em ordem cronológica (janeiro a dezembro). Utilizado para construir gráficos de linha e evolução de vendas.

Parâmetros

Nenhum.

Resposta de Sucesso 200

Array com 12 valores numéricos, onde cada posição representa um mês (índice 0 = janeiro, índice 11 = dezembro):

[
  12500.00,
  18300.50,
  22100.75,
  19800.00,
  31500.25,
  28900.00,
  35200.50,
  41000.00,
  38750.25,
  29600.00,
  44100.75,
  52300.00
]

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/dashboard/recuperar-pedido-mensal" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/dashboard/recuperar-pedido-mensal', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/dashboard/recuperar-pedido-mensal',
    headers={'Authorization': 'Bearer {token}'}
).json()

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/dashboard/recuperar-pedido-mensal", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/dashboard/recuperar-pedido-mensal');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/dashboard/recuperar-pedido-mensal",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/dashboard/recuperar-pedido-mensal",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}