segmentation.list_analytics

Análise de uma lista: vendas, oportunidades e mensagens. Aba "Análise" da lista: sales (audiência, compradores, receita e ticket médio em centavos, frequency por número de compras e monthly compras por mês), opportunities (contatos com oportunidade, em aberto, ganhas e perdidas com valor, por funil) e messages (whatsapp: enviadas aos membros, entregues, lidas e com falha, com a taxa; email e sms são null). Lê até 5000 membros que quem pede vê.

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

Entrada

{
  "$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/segmentation.list_analytics \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000"}'

CLI:

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

MCP: ferramenta segmentation_list_analytics com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "sales": {
      "type": "object",
      "properties": {
        "audienceCount": {
          "type": "number"
        },
        "buyersCount": {
          "type": "number"
        },
        "totalRevenue": {
          "type": "number"
        },
        "avgTicket": {
          "type": "number"
        },
        "frequency": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "bucket": {
                "type": "string"
              },
              "buyers": {
                "type": "number"
              }
            },
            "required": [
              "bucket",
              "buyers"
            ],
            "additionalProperties": false
          }
        },
        "monthly": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "month": {
                "type": "string"
              },
              "purchases": {
                "type": "number"
              }
            },
            "required": [
              "month",
              "purchases"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "audienceCount",
        "buyersCount",
        "totalRevenue",
        "avgTicket",
        "frequency",
        "monthly"
      ],
      "additionalProperties": false
    },
    "opportunities": {
      "type": "object",
      "properties": {
        "totalLeadsWithOpportunities": {
          "type": "number"
        },
        "open": {
          "type": "object",
          "properties": {
            "count": {
              "type": "number"
            },
            "value": {
              "type": "number"
            }
          },
          "required": [
            "count",
            "value"
          ],
          "additionalProperties": false
        },
        "won": {
          "type": "object",
          "properties": {
            "count": {
              "type": "number"
            },
            "value": {
              "type": "number"
            }
          },
          "required": [
            "count",
            "value"
          ],
          "additionalProperties": false
        },
        "lost": {
          "type": "object",
          "properties": {
            "count": {
              "type": "number"
            },
            "value": {
              "type": "number"
            }
          },
          "required": [
            "count",
            "value"
          ],
          "additionalProperties": false
        },
        "totalValue": {
          "type": "number"
        },
        "byPipeline": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "pipelineId": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "count": {
                "type": "number"
              },
              "value": {
                "type": "number"
              },
              "open": {
                "type": "number"
              },
              "won": {
                "type": "number"
              },
              "lost": {
                "type": "number"
              }
            },
            "required": [
              "pipelineId",
              "name",
              "count",
              "value",
              "open",
              "won",
              "lost"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "totalLeadsWithOpportunities",
        "open",
        "won",
        "lost",
        "totalValue",
        "byPipeline"
      ],
      "additionalProperties": false
    },
    "messages": {
      "type": "object",
      "properties": {
        "email": {
          "type": "null"
        },
        "sms": {
          "type": "null"
        },
        "whatsapp": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "total": {
                  "type": "number"
                },
                "delivered": {
                  "type": "object",
                  "properties": {
                    "count": {
                      "type": "number"
                    },
                    "rate": {
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "count",
                    "rate"
                  ],
                  "additionalProperties": false
                },
                "visualized": {
                  "type": "object",
                  "properties": {
                    "count": {
                      "type": "number"
                    },
                    "rate": {
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "count",
                    "rate"
                  ],
                  "additionalProperties": false
                },
                "failed": {
                  "type": "object",
                  "properties": {
                    "count": {
                      "type": "number"
                    },
                    "rate": {
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "count",
                    "rate"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "total",
                "delivered",
                "visualized",
                "failed"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "email",
        "sms",
        "whatsapp"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "sales",
    "opportunities",
    "messages"
  ],
  "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).