AtomiksAPI
Ver .md

products.hub_overview

Cartões e limite de Meus produtos. Totais da tela Meus produtos: produtos (não arquivados), total (com arquivados), ofertas ativas, ofertas aguardando ajuste (incompletas) e faturamento (centavos, vendas ativas do CRM). limit vem de plans.limits.products do plano da conta; null quando o plano não limita.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/products.hub_overview (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_overview
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId products.hub_overview)

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/products.hub_overview \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

node cli/atomiks.mjs products.hub_overview --json '{}'

MCP: ferramenta products_hub_overview com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "products": {
      "type": "number"
    },
    "total": {
      "type": "number"
    },
    "approvedOffers": {
      "type": "number"
    },
    "offersNeedingAttention": {
      "type": "number"
    },
    "revenueCents": {
      "type": "number"
    },
    "limit": {
      "type": [
        "number",
        "null"
      ]
    }
  },
  "required": [
    "products",
    "total",
    "approvedOffers",
    "offersNeedingAttention",
    "revenueCents",
    "limit"
  ],
  "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).