# visitors.funnel

Funil de conversão dos visitantes. Quantos visitantes chegaram a cada etapa (página vista, formulário, checkout, compra) no período, com a taxa sobre a etapa anterior e sobre o topo. `channel` restringe a um canal. Sem rastreio no Atomiks, sem etapas.

- Endpoint: `POST https://app.atomiks.com.br/api/v1/visitors.funnel` (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_funnel`
- Ficha em JSON: `https://app.atomiks.com.br/api/v1/openapi.json` (operationId `visitors.funnel`)

## Entrada

| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
| `startDate` | string (date-time) | sim |  |
| `endDate` | string (date-time) | sim |  |
| `projectId` | string | não |  |
| `timeZone` | string | não |  |
| `channel` | "google" \| "facebook" \| "instagram" \| "tiktok" \| "youtube" \| "linkedin" \| "whatsapp" \| "email" \| "referral" \| "direct" \| "other" | não |  |

<details><summary>JSON Schema</summary>

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "startDate": {
      "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)))$"
    },
    "endDate": {
      "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)))$"
    },
    "projectId": {
      "type": "string",
      "maxLength": 80
    },
    "timeZone": {
      "type": "string",
      "maxLength": 64
    },
    "channel": {
      "type": "string",
      "enum": [
        "google",
        "facebook",
        "instagram",
        "tiktok",
        "youtube",
        "linkedin",
        "whatsapp",
        "email",
        "referral",
        "direct",
        "other"
      ]
    }
  },
  "required": [
    "startDate",
    "endDate"
  ]
}
```

</details>

## Exemplo

```bash
curl -X POST https://app.atomiks.com.br/api/v1/visitors.funnel \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"startDate":"2026-10-01T00:00:00-03:00","endDate":"2026-10-31T23:59:59-03:00"}'
```

CLI:

```bash
node cli/atomiks.mjs visitors.funnel --json '{"startDate":"2026-10-01T00:00:00-03:00","endDate":"2026-10-31T23:59:59-03:00"}'
```

MCP: ferramenta `visitors_funnel` com a mesma entrada.

## Saída

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

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "stages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "eventType": {
            "type": "string"
          },
          "visitors": {
            "type": "number"
          },
          "fromPrevious": {
            "type": "number"
          },
          "fromTop": {
            "type": "number"
          }
        },
        "required": [
          "eventType",
          "visitors",
          "fromPrevious",
          "fromTop"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "stages"
  ],
  "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).