crm.score_overview

Ver a distribuição do Score e o alcance de cada regra. Números da tela Score: distribution (contatos na base, quantos ainda sem cálculo, média, histograma em 10 faixas de largura teto/10, e contatos em Baixo, Médio e Alto), reach (para cada regra, quantos contatos casam com o filtro dela, ligada ou não; null = filtro inválido) e lastRecomputedAt (último recálculo gravado na base). Conta só os contatos que o membro vê. Sem a migration 20261026000008 volta tudo zerado.

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

Entrada

Sem campos: envie {}.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

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

CLI:

node cli/atomiks.mjs crm.score_overview --json '{}'

MCP: ferramenta crm_score_overview com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "distribution": {
      "type": "object",
      "properties": {
        "totalContacts": {
          "type": "number"
        },
        "notScored": {
          "type": "number"
        },
        "average": {
          "type": [
            "number",
            "null"
          ]
        },
        "histogram": {
          "type": "array",
          "items": {
            "type": "number"
          }
        },
        "low": {
          "type": "number"
        },
        "medium": {
          "type": "number"
        },
        "high": {
          "type": "number"
        }
      },
      "required": [
        "totalContacts",
        "notScored",
        "average",
        "histogram",
        "low",
        "medium",
        "high"
      ],
      "additionalProperties": false
    },
    "reach": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": [
          "number",
          "null"
        ]
      }
    },
    "lastRecomputedAt": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "distribution",
    "reach",
    "lastRecomputedAt"
  ],
  "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).