Ver .md

cadences.stats

Painel de uma cadência. Números desde a criação: execuções por situação (runs; successRate = concluídas / (concluídas + esgotadas), avgHoursToComplete da aplicação à conclusão), encerradas por motivo (won, lost, removed, stage_changed, other), uma linha por passo (generated, resolved, positive, negative, noOutcome, open, overdue, currentRuns, avgHoursToResolve; passo removido da cadência aparece só no histórico), os últimos 30 dias (daily, no fuso da conta) e por atendente.

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

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs cadences.stats --json '{"id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta cadences_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": {
    "runs": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        },
        "active": {
          "type": "number"
        },
        "paused": {
          "type": "number"
        },
        "completed": {
          "type": "number"
        },
        "exhausted": {
          "type": "number"
        },
        "stopped": {
          "type": "number"
        },
        "successRate": {
          "type": [
            "number",
            "null"
          ]
        },
        "avgHoursToComplete": {
          "type": [
            "number",
            "null"
          ]
        }
      },
      "required": [
        "total",
        "active",
        "paused",
        "completed",
        "exhausted",
        "stopped",
        "successRate",
        "avgHoursToComplete"
      ],
      "additionalProperties": false
    },
    "stoppedByReason": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "reason",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "steps": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "position": {
            "type": "number"
          },
          "generated": {
            "type": "number"
          },
          "resolved": {
            "type": "number"
          },
          "positive": {
            "type": "number"
          },
          "negative": {
            "type": "number"
          },
          "noOutcome": {
            "type": "number"
          },
          "open": {
            "type": "number"
          },
          "overdue": {
            "type": "number"
          },
          "cancelled": {
            "type": "number"
          },
          "avgHoursToResolve": {
            "type": [
              "number",
              "null"
            ]
          },
          "currentRuns": {
            "type": "number"
          }
        },
        "required": [
          "position",
          "generated",
          "resolved",
          "positive",
          "negative",
          "noOutcome",
          "open",
          "overdue",
          "cancelled",
          "avgHoursToResolve",
          "currentRuns"
        ],
        "additionalProperties": false
      }
    },
    "daily": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "day": {
            "type": "string"
          },
          "started": {
            "type": "number"
          },
          "completed": {
            "type": "number"
          },
          "exhausted": {
            "type": "number"
          }
        },
        "required": [
          "day",
          "started",
          "completed",
          "exhausted"
        ],
        "additionalProperties": false
      }
    },
    "attendants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "attendantId": {
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "type": [
              "string",
              "null"
            ]
          },
          "generated": {
            "type": "number"
          },
          "resolved": {
            "type": "number"
          },
          "positive": {
            "type": "number"
          },
          "negative": {
            "type": "number"
          },
          "noOutcome": {
            "type": "number"
          },
          "open": {
            "type": "number"
          },
          "overdue": {
            "type": "number"
          },
          "cancelled": {
            "type": "number"
          },
          "avgHoursToResolve": {
            "type": [
              "number",
              "null"
            ]
          }
        },
        "required": [
          "attendantId",
          "name",
          "generated",
          "resolved",
          "positive",
          "negative",
          "noOutcome",
          "open",
          "overdue",
          "cancelled",
          "avgHoursToResolve"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "runs",
    "stoppedByReason",
    "steps",
    "daily",
    "attendants"
  ],
  "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).