# activities.filter_options

Opções dos filtros do histórico global. O que os filtros de dimensão de `activities.list` aceitam no período (`startDate`/`endDate`, opcionais): `products`, `tags`, `pipelines` e `flows` com `id`, `name` e `count` (atividades no período); `offers`, `pages`, `funnels` e `messages` vêm vazias (sem fonte). `events` é o catálogo do filtro de tipo: `eventName`, `label` em português, `category` e `hasSource` (false = o Clickmax original tem o tipo e o Atomiks ainda não grava atividade dele).

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

## Entrada

| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
| `startDate` | string | não |  |
| `endDate` | string | não |  |

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

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "startDate": {
      "type": "string",
      "maxLength": 40
    },
    "endDate": {
      "type": "string",
      "maxLength": 40
    }
  }
}
```

</details>

## Exemplo

```bash
curl -X POST https://app.atomiks.com.br/api/v1/activities.filter_options \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"startDate":"2026-10-01","endDate":"2026-10-26"}'
```

CLI:

```bash
node cli/atomiks.mjs activities.filter_options --json '{"startDate":"2026-10-01","endDate":"2026-10-26"}'
```

MCP: ferramenta `activities_filter_options` 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": {
    "offers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "name",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "pages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "name",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "funnels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "name",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "products": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "name",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "name",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "name",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "pipelines": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "name",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "flows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "name",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "hasSource": {
            "type": "boolean"
          }
        },
        "required": [
          "eventName",
          "label",
          "category",
          "hasSource"
        ],
        "additionalProperties": false
      }
    },
    "timezone": {
      "type": "string"
    }
  },
  "required": [
    "offers",
    "pages",
    "funnels",
    "products",
    "tags",
    "messages",
    "pipelines",
    "flows",
    "events",
    "timezone"
  ],
  "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).