visitors.summary

Totais de visitantes. Totais dos cartões de Visitantes: visitantes, novos visitantes, sessões e contatos gerados. O Atomiks ainda não rastreia visitas às páginas, então devolve zeros.

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

Entrada

Campo	Tipo	Obrigatório
`search`	string	não
`projectIds`	string[]	não
`excludeProjectIds`	string[]	não
`pageIds`	string[]	não
`excludePageIds`	string[]	não
`funnelIds`	string[]	não
`excludeFunnelIds`	string[]	não
`channels`	"google" \| "facebook" \| "instagram" \| "tiktok" \| "youtube" \| "linkedin" \| "whatsapp" \| "email" \| "referral" \| "direct" \| "other"[]	não
`excludeChannels`	"google" \| "facebook" \| "instagram" \| "tiktok" \| "youtube" \| "linkedin" \| "whatsapp" \| "email" \| "referral" \| "direct" \| "other"[]	não
`hasLead`	boolean	não

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "search": {
      "type": "string",
      "maxLength": 120
    },
    "projectIds": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 80
      }
    },
    "excludeProjectIds": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 80
      }
    },
    "pageIds": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 80
      }
    },
    "excludePageIds": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 80
      }
    },
    "funnelIds": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 80
      }
    },
    "excludeFunnelIds": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 80
      }
    },
    "channels": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "google",
          "facebook",
          "instagram",
          "tiktok",
          "youtube",
          "linkedin",
          "whatsapp",
          "email",
          "referral",
          "direct",
          "other"
        ]
      }
    },
    "excludeChannels": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "google",
          "facebook",
          "instagram",
          "tiktok",
          "youtube",
          "linkedin",
          "whatsapp",
          "email",
          "referral",
          "direct",
          "other"
        ]
      }
    },
    "hasLead": {
      "type": "boolean"
    }
  }
}

Exemplo

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

CLI:

node cli/atomiks.mjs visitors.summary --json '{}'

MCP: ferramenta visitors_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": {
    "totalVisitors": {
      "type": "number"
    },
    "newVisitors": {
      "type": "number"
    },
    "totalSessions": {
      "type": "number"
    },
    "leadsGenerated": {
      "type": "number"
    }
  },
  "required": [
    "totalVisitors",
    "newVisitors",
    "totalSessions",
    "leadsGenerated"
  ],
  "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).