Ver .md

channel_connections.diagnostics

Eventos e falhas recentes de uma conta conectada. O rastro da conexão (channel_events): os últimos 20 eventos do ciclo da conta (criada, credenciais obtidas, webhooks registrados, ativada, dados atualizados, permissões, desconexão, erro...), cada um com outcome (success, failure, partial, in_progress) e traceId (o request_id que liga ao Registro de auditoria). failures reúne, entre os últimos 100 eventos, os de falha, mais as falhas ao processar webhooks (webhook_events). Só administrador.

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

Entrada

CampoTipoObrigatórioNota
channelIdstring (uuid)sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "channelId": {
      "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": [
    "channelId"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs channel_connections.diagnostics --json '{"channelId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta channel_connections_diagnostics com a mesma entrada.

Saída

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

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

channel_connections.diagnostics · Atomiks API