visitors.filter_options

Opções dos filtros de visitantes. Valores que os filtros Projeto, Página e Funil aceitam (kind), com busca por nome. O Atomiks não tem páginas, funis nem projetos próprios, então a lista é vazia.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "project",
        "page",
        "funnel"
      ]
    },
    "search": {
      "type": "string",
      "maxLength": 120
    }
  },
  "required": [
    "kind"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs visitors.filter_options --json '{"kind":"page"}'

MCP: ferramenta visitors_filter_options com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "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).