AtomiksAPI
Ver .md

groups.campaigns_health

Saúde de todas as campanhas de grupos. Para a lista de campanhas: items com campaignId, score, level e nextAction de cada campanha não encerrada.

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

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

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

CLI:

node cli/atomiks.mjs groups.campaigns_health --json '{}'

MCP: ferramenta groups_campaigns_health 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": {
          "score": {
            "type": "number"
          },
          "level": {
            "type": "string",
            "enum": [
              "ok",
              "attention",
              "critical"
            ]
          },
          "nextAction": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "tab": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "groups",
                      "capture",
                      "messages",
                      "settings"
                    ]
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "label",
              "tab"
            ],
            "additionalProperties": false
          },
          "campaignId": {
            "type": "string"
          }
        },
        "required": [
          "score",
          "level",
          "nextAction",
          "campaignId"
        ],
        "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).