Ver .md

activities.stats

Estatísticas do histórico global. Barra lateral do Histórico de atividades: byCategory (por categoria), topLeads (5 contatos mais ativos), topEventTypes (5 tipos mais frequentes) e byHour (volume por hora do dia, no fuso da conta; só horas com atividade). Sem startDate/endDate, os últimos 30 dias. Conta até as 2 000 atividades mais recentes de cada fonte no período.

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

Entrada

CampoTipoObrigatórioNota
startDatestringnão
endDatestringnão
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "startDate": {
      "type": "string",
      "maxLength": 40
    },
    "endDate": {
      "type": "string",
      "maxLength": 40
    }
  }
}

Exemplo

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

CLI:

node cli/atomiks.mjs activities.stats --json '{}'

MCP: ferramenta activities_stats com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "byCategory": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "category",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "topLeads": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "leadId": {
            "type": "string"
          },
          "leadName": {
            "type": "string"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "leadId",
          "leadName",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "topEventTypes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "eventName": {
            "type": "string"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "eventName",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "byHour": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "hour": {
            "type": "number"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "hour",
          "count"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "byCategory",
    "topLeads",
    "topEventTypes",
    "byHour"
  ],
  "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).