groups.alerts_list
Listar alertas da campanha. Alertas da campanha (no_seat, number_disconnected, invite_invalid, near_full), os mais recentes primeiro. open (padrão verdadeiro) devolve só os não resolvidos. Cada alerta conta quantas vezes se repetiu (count).
- Endpoint:
POST https://app.atomiks.com.br/api/v1/groups.alerts_list(corpo JSON) - Quem pode chamar: membro da conta
- Escopo da chave:
marketing:read - Grava dados: não
- Pela chave de API: sim
- Ferramenta MCP:
groups_alerts_list - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdgroups.alerts_list)
Entrada
| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
campaignId | string (uuid) | sim | |
open | boolean | não | padrão true |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"campaignId": {
"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)$"
},
"open": {
"default": true,
"type": "boolean"
}
},
"required": [
"campaignId"
]
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/groups.alerts_list \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"campaignId":"00000000-0000-4000-8000-000000000001","open":true}'CLI:
node cli/atomiks.mjs groups.alerts_list --json '{"campaignId":"00000000-0000-4000-8000-000000000001","open":true}'MCP: ferramenta groups_alerts_list com a mesma entrada.
Saída
Sucesso: {"data": ...} com o formato abaixo.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string"
},
"details": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"openedAt": {
"type": "string"
},
"lastSeenAt": {
"type": "string"
},
"count": {
"type": "number"
},
"resolvedAt": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"kind",
"details",
"openedAt",
"lastSeenAt",
"count",
"resolvedAt"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"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).