admin.overview.get

Visão geral do painel. Números do sistema para a equipe: contas por status, funil e novas por dia no período (7, 30 ou 90 dias), contas por plano, inativas há 14 dias, ativas sem canal e perto do limite do plano (80%), membros, canais parados (regra webhookHealth), custo de IA por dia, taxa de erro e p95 de duração das chamadas nas últimas 24 h e a fila de atenção: contas pendentes a apagar em até 3 dias, canais parados por conta e erros de log das últimas 24 h agrupados por mensagem. Blocos de IA, requisições e erros vêm null se a tabela ainda não existe. Contas de teste (dono @test.atomiks.dev) ficam fora de todos os números, salvo includeTest. Nunca retorna conteúdo.

• Endpoint: POST https://app.atomiks.com.br/api/v1/admin.overview.get (corpo JSON)
• Quem pode chamar: super-admin da plataforma
• Escopo da chave: admin:read
• Grava dados: não
• Pela chave de API: sim
• Ferramenta MCP: admin_overview_get
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId admin.overview.get)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "days": {
      "default": 30,
      "anyOf": [
        {
          "type": "number",
          "const": 7
        },
        {
          "type": "number",
          "const": 30
        },
        {
          "type": "number",
          "const": 90
        }
      ]
    },
    "includeTest": {
      "default": false,
      "type": "boolean"
    }
  }
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/admin.overview.get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"days":30,"includeTest":false}'

CLI:

node cli/atomiks.mjs admin.overview.get --json '{"days":30,"includeTest":false}'

MCP: ferramenta admin_overview_get com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "accounts": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        },
        "active": {
          "type": "number"
        },
        "pending": {
          "type": "number"
        },
        "blocked": {
          "type": "number"
        },
        "newInPeriod": {
          "type": "number"
        },
        "series": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "count": {
                "type": "number"
              }
            },
            "required": [
              "date",
              "count"
            ],
            "additionalProperties": false
          }
        },
        "funnel": {
          "type": "object",
          "properties": {
            "registered": {
              "type": "number"
            },
            "pending": {
              "type": "number"
            },
            "active": {
              "type": "number"
            }
          },
          "required": [
            "registered",
            "pending",
            "active"
          ],
          "additionalProperties": false
        },
        "byPlan": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "count": {
                "type": "number"
              }
            },
            "required": [
              "key",
              "name",
              "count"
            ],
            "additionalProperties": false
          }
        },
        "inactive": {
          "type": "number"
        },
        "noChannel": {
          "type": "number"
        },
        "nearLimit": {
          "type": "number"
        }
      },
      "required": [
        "total",
        "active",
        "pending",
        "blocked",
        "newInPeriod",
        "series",
        "funnel",
        "byPlan",
        "inactive",
        "noChannel",
        "nearLimit"
      ],
      "additionalProperties": false
    },
    "members": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        }
      },
      "required": [
        "total"
      ],
      "additionalProperties": false
    },
    "channels": {
      "type": "object",
      "properties": {
        "connected": {
          "type": "number"
        },
        "total": {
          "type": "number"
        },
        "staleWebhooks": {
          "type": "number"
        }
      },
      "required": [
        "connected",
        "total",
        "staleWebhooks"
      ],
      "additionalProperties": false
    },
    "ai": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "costUsd": {
              "type": "number"
            },
            "calls": {
              "type": "number"
            },
            "series": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "date": {
                    "type": "string"
                  },
                  "costUsd": {
                    "type": "number"
                  }
                },
                "required": [
                  "date",
                  "costUsd"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "costUsd",
            "calls",
            "series"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "requests": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "errors": {
              "type": "number"
            },
            "errorRate": {
              "type": "number"
            },
            "p95Ms": {
              "type": [
                "number",
                "null"
              ]
            }
          },
          "required": [
            "total",
            "errors",
            "errorRate",
            "p95Ms"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "attention": {
      "type": "object",
      "properties": {
        "purging": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "owner": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string"
                  }
                },
                "required": [
                  "name",
                  "email"
                ],
                "additionalProperties": false
              },
              "purgeAt": {
                "type": "string"
              },
              "daysLeft": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "owner",
              "purgeAt",
              "daysLeft"
            ],
            "additionalProperties": false
          }
        },
        "channels": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "count": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "count"
            ],
            "additionalProperties": false
          }
        },
        "errors": {
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "message": {
                    "type": "string"
                  },
                  "module": {
                    "type": "string"
                  },
                  "count": {
                    "type": "number"
                  },
                  "lastAt": {
                    "type": "string"
                  }
                },
                "required": [
                  "message",
                  "module",
                  "count",
                  "lastAt"
                ],
                "additionalProperties": false
              }
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "purging",
        "channels",
        "errors"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "accounts",
    "members",
    "channels",
    "ai",
    "requests",
    "attention"
  ],
  "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).