overview.summary

Contagens da visão geral. Contatos criados entre from e to (por first_seen_at, fora da lixeira), contatos totais, produtos ativos e os criados desde todayFrom (início do dia do chamador), automações (Instagram) e fluxos não arquivados e ativos da conta. O que o membro não vê pela RLS não entra.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "todayFrom": {
      "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    }
  },
  "required": [
    "from",
    "to",
    "todayFrom"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/overview.summary \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2026-09-27T00:00:00-03:00","to":"2026-10-26T23:59:59-03:00","todayFrom":"2026-10-26T00:00:00-03:00"}'

CLI:

node cli/atomiks.mjs overview.summary --json '{"from":"2026-09-27T00:00:00-03:00","to":"2026-10-26T23:59:59-03:00","todayFrom":"2026-10-26T00:00:00-03:00"}'

MCP: ferramenta overview_summary com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contactsCreated": {
      "type": "number"
    },
    "contactsTotal": {
      "type": "number"
    },
    "products": {
      "type": "number"
    },
    "productsToday": {
      "type": "number"
    },
    "automations": {
      "type": "number"
    },
    "flows": {
      "type": "number"
    },
    "flowsActive": {
      "type": "number"
    }
  },
  "required": [
    "contactsCreated",
    "contactsTotal",
    "products",
    "productsToday",
    "automations",
    "flows",
    "flowsActive"
  ],
  "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).