Ver .md

products.hub_dashboard

Dashboard do produto. Faturamento (centavos) por dia entre from e to (ISO) e os totais do dia, do período e de todo o tempo, sobre as vendas ativas do CRM desse produto (sales).

  • Endpoint: POST https://app.atomiks.com.br/api/v1/products.hub_dashboard (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: crm:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: products_hub_dashboard
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId products.hub_dashboard)

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
fromstring (date-time)sim
tostring (date-time)sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "from": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    },
    "to": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    }
  },
  "required": [
    "id",
    "from",
    "to"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/products.hub_dashboard \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000","from":"2026-10-01T00:00:00.000Z","to":"2026-10-31T23:59:59.999Z"}'

CLI:

node cli/atomiks.mjs products.hub_dashboard --json '{"id":"00000000-0000-0000-0000-000000000000","from":"2026-10-01T00:00:00.000Z","to":"2026-10-31T23:59:59.999Z"}'

MCP: ferramenta products_hub_dashboard com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "chart": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "day": {
            "type": "string"
          },
          "revenueCents": {
            "type": "number"
          }
        },
        "required": [
          "day",
          "revenueCents"
        ],
        "additionalProperties": false
      }
    },
    "today": {
      "type": "object",
      "properties": {
        "revenueCents": {
          "type": "number"
        },
        "sales": {
          "type": "number"
        }
      },
      "required": [
        "revenueCents",
        "sales"
      ],
      "additionalProperties": false
    },
    "period": {
      "type": "object",
      "properties": {
        "revenueCents": {
          "type": "number"
        },
        "sales": {
          "type": "number"
        }
      },
      "required": [
        "revenueCents",
        "sales"
      ],
      "additionalProperties": false
    },
    "total": {
      "type": "object",
      "properties": {
        "revenueCents": {
          "type": "number"
        },
        "sales": {
          "type": "number"
        }
      },
      "required": [
        "revenueCents",
        "sales"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "chart",
    "today",
    "period",
    "total"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).