Mixpanel

Visão geral

Mixpanel é uma plataforma de análise de produto que rastreia interações e engajamento de usuários, oferecendo análise de coortes, funis e testes A/B para melhorar a experiência do usuário. Com a integração no SquadOS, seus agentes podem consultar eventos, segmentar usuários, atualizar perfis e executar queries analíticas avançadas sem sair do fluxo de trabalho automatizado.

• Site oficial: https://mixpanel.com/
• Documentação na Composio: docs.composio.dev/toolkits/mixpanel

Autenticação

Esta ferramenta utiliza autenticação básica (usuário/senha) (BASIC) para conectar. O Mixpanel utiliza HTTP Basic Auth com as credenciais de uma service account — o campo “usuário” é o username da service account e o campo “senha” é o secret gerado no momento da criação.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
username	Sim	Nome de usuário da service account do Mixpanel.
secret	Sim	Segredo da service account, exibido apenas uma vez no momento da criação.

Como obter a credencial

1. Acesse o dashboard do Mixpanel e faça login na sua conta.
2. Clique no ícone da sua organização no canto superior esquerdo e selecione Organization Settings.
3. Na barra lateral, clique em Service Accounts.
4. Clique em Create Service Account.
5. Defina o nome, a função (role) e os projetos aos quais a service account terá acesso.
6. Opcionalmente, configure uma data de expiração para rotação de credenciais.
7. Clique em Create — a tela exibirá o username e o secret. Copie o secret imediatamente, pois não será possível recuperá-lo depois.

Dica

Crie uma service account dedicada para o SquadOS com o papel mínimo necessário (geralmente Analyst). Assim, você pode revogar o acesso individualmente sem afetar outras integrações.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Mixpanel.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa o username e o secret da service account obtidos acima.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Adicionar valores únicos a propriedade de lista de perfil

MIXPANEL_ADD_UNIQUE_TO_PROFILE_LIST_PROPERTY

Adiciona valores únicos a propriedades de lista em perfis de usuário no Mixpanel usando a operação $union. Use quando precisar adicionar itens a propriedades do tipo lista sem criar duplicatas. Ao contrário do $append, o $union garante que os valores sejam únicos na lista. Se a propriedade não existir, cria uma nova lista com os valores fornecidos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ip	integer	Não	Controla a geolocalização. Defina como 0 para desabilitar, 1 para habilitar. Padrão é 1.
data	array	Sim	Lista de objetos de atualização de perfil. Cada objeto deve conter $token, $distinct_id e $union. A operação $union adiciona valores a propriedades de lista sem criar duplicatas.
strict	integer	Não	Habilita validação com mensagens de erro por registro. Defina como 1 para habilitar o modo estrito, 0 para desabilitar.
verbose	integer	Não	Retorna objeto de resposta detalhado. Defina como 1 para resposta JSON com campos status e error, 0 para status em texto simples. Padrão é 0.
callback	string	Não	Nome da função de callback JSONP. Usado para requisições JSONP.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter valores agregados de propriedade de evento

MIXPANEL_AGGREGATED_EVENT_PROPERTY_VALUES

Obtém dados únicos, totais ou médios para um único evento e propriedade ao longo de dias, semanas ou meses. A Query API tem um limite de 60 consultas por hora e no máximo 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da propriedade para a qual deseja obter dados.
type	string (“general” | “unique” | “average”)	Sim	Tipo de análise para o qual deseja obter dados.
unit	string (“minute” | “hour” | “day” | “week” | “month”)	Sim	Nível de granularidade dos dados.
event	string	Sim	Evento para o qual deseja obter dados. Nota: é um único nome de evento, não um array.
limit	integer	Não	Número máximo de valores a retornar.
format	string (“json” | “csv”)	Não	Opções de formato de dados para respostas do Mixpanel.
values	array	Não	Valores específicos da propriedade para os quais deseja obter dados. Exemplo: [‘female’, ‘unknown’].
to_date	string	Não	Data no formato yyyy-mm-dd até a qual consultar (inclusive).
interval	integer	Não	Número de unidades para as quais retornar dados. Especifique interval ou from_date e to_date.
from_date	string	Não	Data no formato yyyy-mm-dd a partir da qual consultar (inclusive).
project_id	integer	Sim	Obrigatório se usar service account para autenticar a requisição.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Agregar contagens de eventos (descontinuado)

MIXPANEL_AGGREGATE_EVENT_COUNTS

DESCONTINUADO: Use MIXPANEL_AGGREGATE_EVENTS. Obtém dados únicos, totais ou médios para eventos ao longo de N dias, semanas ou meses. Use ao analisar tendências e padrões de eventos ao longo do tempo com diferentes métodos de agregação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
type	string (“general” | “unique” | “average”)	Sim	Tipo de análise — determina o método de agregação. Valores válidos: ‘general’, ‘unique’, ‘average’, ‘sum’.
unit	string (“minute” | “hour” | “day” | “week” | “month”)	Sim	Granularidade de tempo para agregação dos dados.
event	string	Sim	Evento ou eventos para os quais obter dados, codificados como string de array JSON (ex.: ’[“Event1”, “Event2”]’).
format	string (“json” | “csv”)	Não	Opções de formato de dados para respostas do Mixpanel.
to_date	string	Não	Data final no formato YYYY-MM-DD (inclusive).
interval	integer	Não	Número de unidades de tempo para retornar dados.
from_date	string	Não	Data inicial no formato YYYY-MM-DD (inclusive). Fortemente recomendado; omitir from_date e to_date pode causar erros de parâmetro ausente.
project_id	integer	Sim	Identificador do projeto para autenticação.
workspace_id	integer	Não	Identificador do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Agregar eventos

MIXPANEL_AGGREGATE_EVENTS

Obtém contagens agregadas de eventos ao longo do tempo. Suporta diferentes tipos de agregação: geral, único, médio e soma.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
type	string (“general” | “unique” | “average” | “sum”)	Não	Tipo de agregação.
unit	string (“minute” | “hour” | “day” | “week” | “month”)	Não	Unidade de tempo para agrupar resultados.
event	string	Não	Nome do evento a analisar. Pelo menos um dos campos event ou events deve ser fornecido.
limit	integer	Não	Número máximo de resultados a retornar.
where	string	Não	Expressão para filtrar eventos.
events	array	Não	Lista de nomes de eventos a analisar.
to_date	string	Sim	Data final da consulta (inclusive).
interval	integer	Não	Intervalo de tempo para os resultados em segundos.
from_date	string	Sim	Data inicial da consulta (inclusive).
project_id	integer	Sim	ID do projeto a consultar.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar coortes salvas

MIXPANEL_COHORTS_LIST

Lista todas as coortes salvas em um projeto do Mixpanel. Use quando precisar recuperar metadados de coortes, incluindo nome, id, contagem, descrição, data de criação e visibilidade. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
project_id	integer	Sim	ID do projeto a consultar. Obrigatório para listar coortes.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar tag de anotação

MIXPANEL_CREATE_ANNOTATION_TAG

Cria uma nova tag de anotação no Mixpanel com o nome fornecido. Use quando precisar criar tags para organizar e categorizar anotações. Requer função de Analyst ou superior.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da tag de anotação a criar.
project_id	string	Sim	Identificador do projeto onde a tag será criada.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar identidade

MIXPANEL_CREATE_IDENTITY

Cria um mapeamento de identidade no Mixpanel vinculando um ID anônimo a um ID de usuário identificado. Use quando precisar conectar a atividade anônima pré-login com a atividade identificada pós-login. Esta operação é tipicamente realizada após autenticação do usuário para associar todos os eventos anônimos anteriores ao perfil identificado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
token	string	Sim	Token de autenticação do projeto para autenticação do lado do cliente.
strict	integer (“0” | “1”)	Não	Modo de validação da requisição.
anon_id	string	Sim	ID anônimo (formato UUID v4) a ser vinculado ao ID identificado. Tipicamente o ID usado antes da autenticação do usuário.
distinct_id	string	Não	ID distinto opcional. Se fornecido, será usado como pós-ID da identidade.
identified_id	string	Sim	ID identificado do usuário a vincular ao ID anônimo. Tipicamente o ID do usuário após cadastro ou login.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar service account

MIXPANEL_CREATE_SERVICE_ACCOUNT

Cria uma nova service account para sua organização e opcionalmente a adiciona a projetos. Use quando precisar gerar credenciais de API para acesso programático. A resposta inclui um token (secret) que não pode ser recuperado após a criação. Requer service account com função de admin ou owner.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
role	string (“owner” | “admin” | “analyst” | “consumer”)	Não	Função no nível da organização para a service account. Se não especificado, a service account não terá função organizacional.
expires	string	Não	String de data-hora no formato ISO 8601 indicando quando a service account deve expirar.
projects	array	Não	Lista de projetos para adicionar a service account com funções especificadas.
username	string	Sim	Nome descritivo para a service account.
organization_id	string	Sim	Identificador único da organização.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir grupo

MIXPANEL_DELETE_GROUP

Exclui permanentemente um perfil de grupo do Mixpanel Group Analytics. Use quando precisar remover completamente um perfil de grupo e todas as suas propriedades. A exclusão é permanente e não pode ser desfeita. Propriedades de grupo em eventos históricos permanecem intactas mesmo após a exclusão.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
time	integer	Não	Timestamp Unix em milissegundos para quando a exclusão deve ser registrada. Se não fornecido, usa o horário atual.
token	string	Sim	Token do projeto Mixpanel para autenticação.
group_id	string	Sim	Identificador único do grupo específico a excluir permanentemente.
group_key	string	Sim	Identificador da categoria/tipo de grupo (ex.: ‘company’, ‘organization’, ‘team’).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir perfil

MIXPANEL_DELETE_PROFILE

Exclui permanentemente um perfil de usuário do Mixpanel, junto com todas as suas propriedades. Use quando precisar remover completamente um perfil. A exclusão é permanente e não pode ser desfeita. Isso exclui apenas o perfil, não os eventos associados. Para perfis duplicados, use $ignore_alias: true para evitar excluir o perfil original.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ip	string	Não	Endereço IP para atribuição de requisição. Defina como ‘0’ para não atualizar dados de geolocalização.
token	string	Sim	Token de autenticação do projeto para autenticação na API.
distinct_id	string	Sim	Identificador único do perfil de usuário a excluir permanentemente.
ignore_time	boolean	Não	Se verdadeiro, o Mixpanel não atualizará automaticamente a propriedade ‘Last Seen’ antes da exclusão.
ignore_alias	boolean	Não	Se verdadeiro, evita a exclusão do perfil original ao excluir duplicatas usando um alias como distinct_id.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir múltiplos perfis (lote)

MIXPANEL_DELETE_PROFILE_BATCH

Exclui permanentemente múltiplos perfis de usuário do Mixpanel em uma única requisição em lote. Use quando precisar excluir múltiplos perfis de forma eficiente. A exclusão é permanente e não pode ser desfeita. Exclui apenas os perfis, não os eventos associados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
profiles	array	Sim	Lista de operações de exclusão de perfil. Cada perfil deve incluir $token, $distinct_id e $delete. Máximo de 50 exclusões por requisição recomendado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir propriedade de perfil

MIXPANEL_DELETE_PROFILE_PROPERTY

Exclui permanentemente propriedades de um perfil de usuário do Mixpanel usando a operação $unset. Use quando precisar remover propriedades e seus valores de um perfil. As propriedades são removidas permanentemente e não podem ser recuperadas. Útil ao limpar propriedades ou ao se aproximar do limite de 2000 propriedades por perfil do Mixpanel.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ip	string	Não	Endereço IP para atribuição de requisição. Defina como ‘0’ para não atualizar dados de geolocalização.
time	integer	Não	Timestamp Unix para quando a operação ocorreu.
token	string	Sim	Token de autenticação do projeto para autenticação na API.
unset	array	Sim	Lista de nomes de propriedades a remover permanentemente do perfil.
distinct_id	string	Sim	Identificador único do perfil de usuário a atualizar.
ignore_time	boolean	Não	Se verdadeiro, o Mixpanel não atualizará automaticamente a propriedade ‘Last Seen’.
ignore_alias	boolean	Não	Se verdadeiro, ignora o processamento de alias e usa o distinct_id diretamente.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter todos os projetos

MIXPANEL_GET_ALL_PROJECTS

Obtém todos os projetos associados à conta Mixpanel autenticada. Retorna detalhes do projeto incluindo nome, permissões, função, domínio e outros detalhes de configuração. Se um projeto parecer inacessível, verifique se a região da conexão corresponde ao cluster do projeto antes de supor um problema de permissão.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter tags de anotação

MIXPANEL_GET_ANNOTATION_TAGS_ALT1

Obtém todas as tags de anotação de um projeto do Mixpanel. Use quando precisar recuperar tags adicionadas a anotações. Requer função de Analyst ou superior.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
project_id	string	Sim	Identificador único do projeto Mixpanel.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar perfis de grupo em lote

MIXPANEL_GROUP_BATCH_UPDATE

Envia um lote de atualizações de perfis de grupo para o Mixpanel. Use quando precisar atualizar múltiplos perfis de grupo em uma única requisição. Suporta operações como $set, $set_once, $union, $remove, $unset e $delete. Nota: $add NÃO é suportado para perfis de grupo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	array	Sim	Lista de objetos de atualização de perfil de grupo. Cada objeto contém os identificadores do grupo e as operações a realizar.
response_format	string (“IP” | “Strict” | “Verbose”)	Não	Controla o formato da resposta. IP: retorna ‘1’ para dados válidos; Strict: retorna erro para registros inválidos; Verbose: resposta detalhada.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir propriedades de grupo

MIXPANEL_GROUP_DELETE_PROPERTY

Exclui propriedades específicas de um perfil de grupo do Mixpanel. Use quando precisar remover permanentemente propriedades indesejadas de um grupo (empresa, organização, equipe, etc.). A operação usa $unset para remover permanentemente as propriedades especificadas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
token	string	Sim	Token de autenticação do projeto Mixpanel.
group_id	string	Sim	Identificador único do grupo específico a atualizar.
group_key	string	Sim	Identificador da categoria/tipo de grupo (ex.: ‘company’, ‘organization’, ‘team’).
properties	array	Sim	Lista de nomes de propriedades a excluir/desmarcar do perfil do grupo.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Definir propriedades de grupo (lote) (descontinuado)

MIXPANEL_GROUP_SET_PROPERTY

DESCONTINUADO: Use MIXPANEL_GROUP_BATCH_UPDATE. Envia atualizações de perfil de grupo em lote para o Mixpanel. Suporta múltiplas operações: $set (atualizar/adicionar), $set_once (definir se não existe), $unset (excluir), $remove (remover da lista), $union (adicionar à lista de forma única).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
groups	array	Sim	Lista de atualizações de perfil de grupo. Cada atualização deve incluir $token, $group_key, $group_id e pelo menos uma operação ($set, $set_once, $unset, $remove ou $union).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar alias de identidade

MIXPANEL_IDENTITY_CREATE_ALIAS

Cria um mapeamento de alias entre dois IDs distintos no Mixpanel. Use quando precisar vincular um novo identificador a um existente. Disponível apenas para projetos que usam o sistema Original ID Merge e Legacy ID Management System; não tem efeito no sistema Simplified ID Merge. Tipicamente chamado uma vez durante o cadastro do usuário para conectar eventos anônimos pré-cadastro com a atividade pós-cadastro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
alias	string	Sim	Novo valor de distinct_id que será interpretado como o distinct_id existente. Cada alias só pode mapear para um distinct_id.
token	string	Sim	Token de autenticação do projeto para autenticação do lado do cliente.
distinct_id	string	Sim	ID distinto existente a ser mesclado com o alias. Este é o identificador original para o qual o alias mapeará.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Executar query JQL

MIXPANEL_JQL_QUERY

Executa uma query JQL (JavaScript Query Language) personalizada na Query API do Mixpanel. Restrições principais: 60 queries/hora, máx. 5 queries simultâneas; timeout de 2 minutos; limite de 5 GB de processamento de dados, 2 GB de saída; sem requisições de rede remotas (XMLHttpRequest) dentro do script.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
params	object	Não	Objeto JSON que ficará disponível no script como params. Use para passar intervalos de datas dinâmicos, nomes de eventos ou outros parâmetros para a query JQL.
script	string	Sim	Trecho de código JavaScript válido para o motor JQL do Mixpanel. DEVE definir exatamente uma função de nível superior function main() { ... } que retorna o dataset final.
project_id	integer	Sim	Obrigatório se usar credenciais de service account ou API secret para autenticação.
workspace_id	integer	Não	ID do workspace do Mixpanel, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar coortes salvas (descontinuado)

MIXPANEL_LIST_COHORTS

DESCONTINUADO: Use MIXPANEL_MIXPANEL_COHORTS_LIST. Obtém lista de todas as coortes em um projeto do Mixpanel. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
project_id	integer	Sim	ID do projeto a consultar. Obrigatório se usar autenticação por service account.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar funis salvos

MIXPANEL_LIST_FUNNELS

Obtém os nomes e funnel_ids dos seus funis. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
project_id	integer	Sim	Obrigatório se usar service account para autenticar a requisição.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar coortes salvas (descontinuado)

MIXPANEL_LIST_SAVED_COHORTS

DESCONTINUADO: Use MIXPANEL_MIXPANEL_COHORTS_LIST. Lista todas as coortes salvas em um projeto do Mixpanel. Use quando precisar recuperar metadados de coortes, incluindo nome, id, contagem, descrição, data de criação e visibilidade.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
project_id	integer	Sim	ID do projeto a consultar. Obrigatório para listar coortes.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar service accounts

MIXPANEL_LIST_SERVICE_ACCOUNTS

Lista todas as service accounts de uma organização. Use quando precisar recuperar service accounts, verificar quando foram usadas pela última vez ou quando expiram. Requer service account com função de admin ou owner.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
organization_id	string	Sim	Identificador único da organização.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Adicionar valor à propriedade de lista de perfil (append)

MIXPANEL_PROFILE_APPEND_TO_LIST_PROPERTY

Adiciona valores a propriedades de lista em perfis de usuário no Mixpanel. Use quando precisar adicionar itens a propriedades do tipo lista. Ao contrário do $union, o $append permite valores duplicados. Se a propriedade não existir, cria uma nova lista com o valor como primeiro elemento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	array	Sim	Lista de objetos de atualização de perfil. Cada objeto deve conter $token, $distinct_id e $append.
verbose	integer	Não	Quando definido como 1, retorna resposta JSON detalhada com campos status e error. Quando 0 (padrão), retorna status em texto simples.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar múltiplos perfis (lote)

MIXPANEL_PROFILE_BATCH_UPDATE

Atualiza múltiplos perfis de usuário no Mixpanel em uma única requisição em lote. Use quando precisar atualizar propriedades de múltiplos usuários de forma eficiente. Suporta as operações: $set, $set_once, $add, $union, $append, $remove, $unset e $delete. Máximo de 50 atualizações por requisição.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
profiles	array	Sim	Lista de atualizações de perfil. Máximo de 50 atualizações por requisição. Cada perfil deve incluir $token e $distinct_id ou $user_id, mais pelo menos uma operação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir propriedade de perfil (descontinuado)

MIXPANEL_PROFILE_DELETE_PROPERTY

DESCONTINUADO: Use MIXPANEL_DELETE_PROFILE_PROPERTY. Exclui permanentemente propriedades de um perfil de usuário no Mixpanel usando $unset. As propriedades removidas não podem ser recuperadas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ip	string	Não	Endereço IP para atribuição de requisição. Defina como ‘0’ para não atualizar dados de geolocalização.
time	integer	Não	Timestamp Unix para quando a operação ocorreu.
token	string	Sim	Token de autenticação do projeto para autenticação na API.
unset	array	Sim	Lista JSON de nomes de propriedades a remover permanentemente do perfil.
distinct_id	string	Sim	Identificador único do perfil de usuário a atualizar.
ignore_time	boolean	Não	Se verdadeiro, o Mixpanel não atualizará automaticamente a propriedade ‘Last Seen’.
ignore_alias	boolean	Não	Se verdadeiro, ignora o processamento de alias e usa o distinct_id diretamente.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter atividade de eventos de perfil

MIXPANEL_PROFILE_EVENT_ACTIVITY

Obtém o feed de atividade de eventos para usuários especificados da Query API do Mixpanel. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
to_date	string	Sim	Data final da consulta (inclusive, formato: YYYY-MM-DD).
from_date	string	Sim	Data inicial da consulta (inclusive, formato: YYYY-MM-DD).
project_id	integer	Sim	ID do projeto a consultar. Obrigatório se usar autenticação por service account.
distinct_ids	array	Sim	Lista de distinct_ids para os quais retornar feeds de atividade.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Incrementar propriedade numérica de perfil

MIXPANEL_PROFILE_NUMERICAL_ADD

Incrementa ou decrementa propriedades numéricas em perfis de usuário no Mixpanel. Use quando precisar adicionar valores a propriedades numéricas existentes (ex.: contagens de login, pontos, créditos). Se uma propriedade não existir, o valor é somado a zero. Use valores negativos para decrementar.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ip	string	Não	Endereço IP para geolocalização. Defina como 0 ou ‘0’ para evitar atualizar dados de localização.
add	object	Sim	Objeto JSON contendo nomes de propriedades como chaves e valores numéricos de incremento.
time	integer	Não	Timestamp Unix para sobrescrever o horário da atualização.
token	string	Sim	Token de autenticação do projeto Mixpanel.
verbose	integer	Não	Quando definido como 1, retorna resposta JSON detalhada. Quando 0 (padrão), retorna status em texto simples.
distinct_id	string	Sim	Identificador único do perfil de usuário.
ignore_time	boolean	Não	Se verdadeiro, impede a atualização da propriedade ‘Last Seen’. Padrão é falso.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Remover da propriedade de lista de perfil

MIXPANEL_PROFILE_REMOVE_FROM_LIST_PROPERTY

Remove valores de propriedades de lista em perfis de usuário no Mixpanel. Use quando precisar remover itens específicos de propriedades do tipo lista. Se o valor não existir na lista, nenhuma atualização é feita. Se a propriedade não existir ou não for do tipo lista, a operação é ignorada.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	array	Sim	Lista de objetos de atualização de perfil. Cada objeto deve conter $token, $distinct_id e $remove.
verbose	integer	Não	Quando definido como 1, retorna resposta JSON detalhada. Quando 0 (padrão), retorna status em texto simples.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Definir propriedades de perfil

MIXPANEL_PROFILE_SET

Define propriedades de perfil de usuário no Mixpanel usando a operação $set. Use quando precisar criar ou atualizar propriedades em um perfil de usuário. As propriedades especificadas serão criadas se não existirem ou sobrescritas se existirem. Se o perfil não existir, será criado com essas propriedades.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ip	string	Não	Endereço IP para enriquecimento de geolocalização. Defina como ‘0’ para evitar atualizar dados de geolocalização.
time	integer	Não	Timestamp Unix (segundos desde a época) indicando quando a atualização do perfil ocorreu.
token	string	Sim	Token de autenticação do projeto Mixpanel. Obrigatório para autenticar a requisição.
distinct_id	string	Sim	Identificador único do perfil de usuário a atualizar.
ignore_time	boolean	Não	Se verdadeiro, impede o Mixpanel de atualizar automaticamente a propriedade ‘Last Seen’.
set_properties	object	Sim	Dicionário de propriedades a definir no perfil de usuário. Propriedades comuns incluem ‘name’, ‘email’, ‘status’, etc.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar relatório de frequência

MIXPANEL_QUERY_FREQUENCY_REPORT

Obtém dados sobre com que frequência os usuários estão realizando eventos. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
on	string	Não	Expressão de propriedade pela qual segmentar o segundo evento.
unit	string (“day” | “week” | “month”)	Sim	Período de tempo geral para retornar a frequência de ações.
event	string	Não	Evento para o qual gerar contagens de retorno.
limit	integer	Não	Retorna os N principais valores de segmentação.
where	string	Não	Expressão para filtrar os eventos retornados.
to_date	string	Sim	Data no formato yyyy-mm-dd até a qual consultar (inclusive).
from_date	string	Sim	Data no formato yyyy-mm-dd a partir da qual consultar (inclusive).
project_id	integer	Sim	Obrigatório se usar service account para autenticar a requisição.
workspace_id	integer	Não	ID do workspace, se aplicável.
addiction_unit	string (“hour” | “day”)	Sim	Granularidade para retornar a frequência de ações.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar funil salvo

MIXPANEL_QUERY_FUNNEL

Obtém dados para um funil. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
on	string	Não	Expressão de propriedade pela qual segmentar o evento.
unit	string (“day” | “week” | “month”)	Não	Unidades de tempo de médio alcance para operações do Mixpanel.
limit	integer	Não	Retorna os N principais valores de propriedade. Valor máximo: 10.000.
where	string	Não	Expressão para filtrar eventos.
length	integer	Não	Número de unidades que cada usuário tem para completar o funil. Não pode ser maior que 90 dias.
to_date	string	Sim	Data no formato yyyy-mm-dd até a qual consultar (inclusive).
interval	integer	Não	Número de dias em cada bucket.
from_date	string	Sim	Data no formato yyyy-mm-dd a partir da qual consultar (inclusive).
funnel_id	integer	Sim	ID do funil para o qual deseja obter dados.
project_id	integer	Sim	Obrigatório se usar service account para autenticar a requisição.
length_unit	string (“second” | “minute” | “hour” | “day”)	Não	Unidades de tempo estendidas incluindo segundos para análise de funil.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar insight salvo

MIXPANEL_QUERY_INSIGHT

Obtém dados dos seus relatórios de Insights. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
project_id	integer	Sim	Obrigatório se usar service account para autenticar a requisição. Deve corresponder à região/cluster da conexão configurada.
bookmark_id	integer	Sim	ID do seu relatório de Insights.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter nomes dos principais eventos (últimos 31 dias) (descontinuado)

MIXPANEL_QUERY_MONTHS_TOP_EVENT_NAMES

DESCONTINUADO: Use MIXPANEL_TOP_EVENTS. Obtém lista dos nomes de eventos mais comuns nos últimos 31 dias. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
type	string (“general” | “unique” | “average”)	Sim	Tipo de análise para a consulta — geral, único ou médio.
limit	integer	Não	Número máximo de nomes de eventos a retornar. Padrão é 255.
project_id	integer	Sim	Identificador do projeto. Obrigatório se usar service account para autenticar a requisição.
workspace_id	integer	Não	Identificador do workspace. Obrigatório apenas para projetos com Data Views habilitado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar relatório de média numérica

MIXPANEL_QUERY_NUMERIC_AVERAGE

Calcula a média de uma expressão para eventos por unidade de tempo. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
on	string	Sim	Expressão numérica a calcular a média por unidade de tempo (deve avaliar para um número).
unit	string (“hour” | “day”)	Não	Unidades de tempo menores para certas operações do Mixpanel.
event	string	Sim	Evento para o qual obter dados (nome de evento único).
where	string	Não	Expressão para filtrar eventos.
to_date	string	Sim	Data no formato yyyy-mm-dd até a qual consultar (inclusive).
from_date	string	Sim	Data no formato yyyy-mm-dd a partir da qual consultar (inclusive).
project_id	integer	Sim	Obrigatório se usar service account para autenticar a requisição.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar relatório de soma numérica

MIXPANEL_QUERY_NUMERIC_SUM

Soma uma expressão para eventos por unidade de tempo. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
on	string	Sim	Expressão numérica a somar por unidade de tempo (deve avaliar para um número).
unit	string (“hour” | “day”)	Não	Unidades de tempo menores para certas operações do Mixpanel.
event	string	Sim	Evento para o qual obter dados (nome de evento único).
where	string	Não	Expressão para filtrar eventos.
to_date	string	Sim	Data no formato yyyy-mm-dd até a qual consultar (inclusive).
from_date	string	Sim	Data no formato yyyy-mm-dd a partir da qual consultar (inclusive).
project_id	integer	Sim	Obrigatório se usar service account para autenticar a requisição.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar perfis

MIXPANEL_QUERY_PROFILES

Consulta dados de perfil de usuário ou grupo do Mixpanel. Retorna lista de perfis que correspondem aos parâmetros especificados. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Qual página de resultados recuperar (começa em 0).
where	string	Não	Expressão para filtrar usuários (ou grupos).
behaviors	integer	Não	Obrigatório ao usar seletor de evento para perfis de usuário.
project_id	integer	Sim	ID do projeto a consultar. Obrigatório se usar autenticação por service account.
session_id	string	Não	ID de sessão de uma consulta anterior para paginação.
distinct_id	string	Não	Identificador único para distinguir um perfil individual.
distinct_ids	array	Não	Lista de distinct_ids para recuperar perfis.
workspace_id	integer	Não	ID do workspace, se aplicável.
data_group_id	string	Não	ID da chave de grupo, usado ao consultar perfis de grupo.
as_of_timestamp	integer	Não	Usado com o parâmetro behaviors para exportações grandes.
filter_by_cohort	object	Não	Filtrar por ID de coorte. Exemplo: {‘id’: 12345}.
include_all_users	boolean	Não	Ao usar filter_by_cohort, se deve incluir todos os distinct_ids mesmo sem perfis.
output_properties	array	Não	Lista de nomes de propriedades a retornar na resposta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar relatório de retenção

MIXPANEL_QUERY_RETENTION_REPORT

Consulta análise de coorte mostrando padrões de retenção de usuários ao longo do tempo. Rastreia como usuários que realizaram um evento inicial (born_event) realizam subsequentemente um evento alvo. Use o parâmetro ‘unit’ para controlar a granularidade do intervalo de coorte (‘day’, ‘week’, ‘month’); o padrão é ‘day’.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
on	string	Não	Expressão de propriedade para segmentação.
unit	string (“day” | “week” | “month”)	Não	Unidades de tempo de médio alcance para operações do Mixpanel.
event	string	Não	Evento alvo para medir retenção.
limit	integer	Não	Número máximo de valores de segmentação a retornar (válido apenas com o parâmetro ‘on’).
where	string	Não	Expressão de filtro para o evento.
to_date	string	Sim	Data final do intervalo de consulta no formato YYYY-MM-DD (inclusive).
from_date	string	Sim	Data inicial do intervalo de consulta no formato YYYY-MM-DD (inclusive).
born_event	string	Não	Evento inicial que define a entrada na coorte (obrigatório quando retention_type=‘birth’).
born_where	string	Não	Expressão de filtro para born_event.
project_id	integer	Sim	Identificador do projeto (obrigatório ao usar autenticação por service account).
workspace_id	integer	Não	Identificador do workspace, se aplicável.
interval_count	integer	Não	Número de buckets/intervalos individuais a retornar.
retention_type	string (“birth” | “compounded”)	Não	Tipo de análise de retenção: ‘birth’ para retenção de primeira vez ou ‘compounded’ para retenção recorrente.
unbounded_retention	boolean	Não	Quando verdadeiro, usa método de acumulação onde valores se acumulam da direita para a esquerda.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar relatório de segmentação

MIXPANEL_QUERY_SEGMENTATION

Obtém dados de um evento, segmentados e filtrados por propriedades com divisão diária/temporal. Use o parâmetro ‘unit’ para controlar o agrupamento de tempo (‘minute’, ‘hour’, ‘day’, ‘month’). A Query API tem limite de 60 consultas por hora e 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
on	string	Não	Expressão de propriedade pela qual segmentar o evento. Propriedades não definidas para muitos eventos produzem buckets de segmento ‘undefined’.
type	string (“general” | “unique” | “average”)	Não	Tipos de análise para agregação de eventos do Mixpanel.
unit	string (“minute” | “hour” | “day” | “month”)	Não	Unidades de tempo para consultas de segmentação.
event	string	Sim	Evento para o qual obter dados (nome de evento único).
limit	integer	Não	Retornar os N principais valores de propriedade (máx. 10000).
where	string	Não	Expressão para filtrar eventos.
to_date	string	Sim	Data no formato yyyy-mm-dd até a qual consultar (inclusive).
from_date	string	Sim	Data no formato yyyy-mm-dd a partir da qual consultar (inclusive). Use o fuso horário do projeto para evitar erros de intervalo.
project_id	integer	Sim	Obrigatório se usar service account para autenticar a requisição. Incompatibilidade de região retorna ‘invalid project id for cluster’.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar principais eventos de hoje

MIXPANEL_QUERY_TOP_EVENTS

Obtém os principais eventos de hoje, com suas contagens e a variação percentual normalizada em relação a ontem. Use quando precisar analisar o desempenho dos eventos de hoje em comparação com ontem.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
type	string (“general” | “unique” | “average”)	Sim	Tipo de análise — geral, único ou médio.
limit	integer	Não	Número máximo de eventos a retornar.
project_id	integer	Sim	Identificador do projeto. Obrigatório se usar service account para autenticar a requisição.
workspace_id	integer	Não	Identificador do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Remover da propriedade de lista de grupo

MIXPANEL_REMOVE_FROM_GROUP_LIST_PROPERTY

Remove valores de propriedades de lista em perfis de grupo no Mixpanel. Use quando precisar remover itens específicos de propriedades do tipo lista em grupos (empresas, organizações, etc.). Se o valor não existir na lista, nenhuma atualização é feita.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	array	Sim	Lista de objetos de atualização de perfil de grupo. Cada objeto deve conter $token, $group_key, $group_id e $remove.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Remover da propriedade de lista de perfil

MIXPANEL_REMOVE_FROM_LIST_PROPERTY

Remove valores de propriedades de lista em perfis de usuário no Mixpanel usando a operação $remove. Use quando precisar remover itens específicos de propriedades do tipo lista. Se o valor não existir na lista, nenhuma ação é tomada. O perfil será criado se não existir.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ip	string	Não	Endereço IP para enriquecimento de geolocalização. Defina como ‘0’ para evitar atualizar dados de geolocalização.
time	integer	Não	Timestamp Unix (segundos desde a época) indicando quando a atualização do perfil ocorreu.
token	string	Sim	Token de autenticação do projeto Mixpanel. Obrigatório para autenticar a requisição.
distinct_id	string	Sim	Identificador único do perfil de usuário a atualizar.
ignore_time	boolean	Não	Se verdadeiro, impede o Mixpanel de atualizar automaticamente a propriedade ‘Last Seen’.
remove_properties	object	Sim	Dicionário de propriedades de lista e valores a remover. Cada chave é um nome de propriedade e cada valor é o item a remover dessa propriedade de lista.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consulta de segmentação com bucket numérico

MIXPANEL_SEGMENTATION_NUMERIC_QUERY

Obtém dados de eventos agrupados numericamente por valores de propriedade. Use quando precisar analisar distribuições de propriedades numéricas como receita, duração de sessão ou contagens com agrupamento automático.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
on	string	Sim	Expressão de propriedade numérica para agrupar. Use o formato ‘number(nome_propriedade)’ ou expressões numéricas.
type	string (“general” | “unique” | “average”)	Não	Tipos de análise para agregação de eventos do Mixpanel.
unit	string (“hour” | “day” | “week” | “month”)	Não	Unidades de tempo maiores para certas análises.
event	string	Sim	Nome do evento para o qual obter dados.
where	string	Não	Expressão para filtrar eventos.
to_date	string	Sim	Data no formato yyyy-mm-dd até a qual consultar (inclusive).
from_date	string	Sim	Data no formato yyyy-mm-dd a partir da qual consultar (inclusive).
project_id	integer	Sim	Obrigatório se usar service account para autenticar a requisição.
bucket_size	integer	Não	Tamanho dos buckets numéricos para agrupar valores. Se não especificado, o Mixpanel determina automaticamente.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Definir propriedade de grupo apenas uma vez

MIXPANEL_SET_GROUP_PROPERTY_ONCE

Define propriedades em um perfil de grupo do Mixpanel apenas se elas ainda não existirem. Use quando precisar definir propriedades iniciais de um grupo sem sobrescrever valores existentes. Ideal para definir valores padrão ou rastrear quando um grupo foi criado pela primeira vez.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
token	string	Sim	Token de autenticação do projeto para autenticação na API do Mixpanel.
group_id	string	Sim	Identificador único para a instância específica do grupo.
group_key	string	Sim	Identificador do tipo de grupo (ex.: ‘Company’, ‘Organization’, ‘Team’). Define a categoria do grupo.
properties	object	Sim	Pares chave-valor de propriedades a definir no perfil do grupo. As propriedades só serão definidas se ainda não existirem no grupo.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Definir propriedade de perfil apenas uma vez

MIXPANEL_SET_PROFILE_PROPERTY_ONCE

Define propriedades de perfil de usuário no Mixpanel usando a operação $set_once. Use quando precisar definir propriedades que devem ser registradas apenas no valor inicial. As propriedades especificadas serão criadas apenas se ainda não existirem no perfil. Ideal para rastrear valores de primeira vez como origem do cadastro, referenciador inicial ou data do primeiro login.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ip	string	Não	Endereço IP para enriquecimento de geolocalização. Defina como ‘0’ para evitar atualizar dados de geolocalização.
time	integer	Não	Timestamp Unix (segundos desde a época) indicando quando a atualização do perfil ocorreu.
token	string	Sim	Token de autenticação do projeto Mixpanel. Obrigatório para autenticar a requisição.
distinct_id	string	Sim	Identificador único do perfil de usuário a atualizar.
ignore_time	boolean	Não	Se verdadeiro, impede o Mixpanel de atualizar automaticamente a propriedade ‘Last Seen’.
set_once_properties	object	Sim	Dicionário de propriedades a definir no perfil de usuário apenas se ainda não existirem. Útil para rastrear valores iniciais como ‘First Login’, ‘Signup Source’, ‘Initial Referrer’, etc.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter principais eventos de hoje (descontinuado)

MIXPANEL_TODAYS_TOP_EVENTS

DESCONTINUADO: Use MIXPANEL_QUERY_TOP_EVENTS. Obtém os principais eventos de hoje, com suas contagens e a variação percentual normalizada em relação a ontem. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
type	string (“general” | “unique” | “average”)	Sim	Tipo de análise para o qual deseja obter dados — geral, único ou médio.
limit	integer	Não	Número máximo de eventos a retornar.
project_id	integer	Sim	Obrigatório se usar service account para autenticar a requisição.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter principais propriedades de evento

MIXPANEL_TOP_EVENT_PROPERTIES

Obtém os principais nomes de propriedades de um evento. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
event	string	Sim	Evento para o qual deseja obter dados. Nota: é um único nome de evento, não um array.
limit	integer	Não	Número máximo de propriedades a retornar.
project_id	integer	Sim	Obrigatório se usar service account para autenticar a requisição.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter principais valores de propriedade de evento

MIXPANEL_TOP_EVENT_PROPERTY_VALUES

Obtém os principais valores de uma propriedade ordenados por frequência. Use quando precisar entender os valores mais comuns para uma propriedade específica em um evento. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas. Em caso de resposta 429, aplique backoff exponencial.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da propriedade para a qual deseja obter dados.
event	string	Sim	Evento para o qual deseja obter dados. Nota: é um único nome de evento, não um array.
limit	integer	Não	Número máximo de valores a retornar.
project_id	integer	Sim	Obrigatório se usar service account para autenticar a requisição.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter principais eventos

MIXPANEL_TOP_EVENTS

Obtém lista dos eventos mais comuns nos últimos 31 dias. A Query API tem limite de 60 consultas por hora e máximo de 5 consultas simultâneas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
type	string (“general” | “unique” | “average”)	Sim	Tipo de análise para o qual deseja obter dados — geral, único ou médio.
limit	integer	Não	Número máximo de valores a retornar.
project_id	integer	Sim	Obrigatório se usar service account para autenticar a requisição.
workspace_id	integer	Não	ID do workspace, se aplicável.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Unir à propriedade de lista de grupo

MIXPANEL_UPDATE_GROUP_LIST_PROPERTY

Adiciona valores únicos a propriedades de lista em perfis de grupo no Mixpanel. Use quando precisar adicionar itens a propriedades de lista de grupo sem criar duplicatas. A operação $union garante que os valores só sejam adicionados se ainda não existirem na lista.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ip	integer	Não	Controla o processamento de geolocalização. Defina como 0 para desabilitar, 1 para habilitar.
data	array	Sim	Lista de objetos de atualização de union de grupo. Cada objeto deve conter $token, $group_key, $group_id e $union.
strict	integer	Não	Habilita validação com mensagens de erro. Defina como 1 para modo estrito, 0 para desabilitar.
verbose	integer	Não	Retorna informações detalhadas de sucesso/falha da operação. Defina como 1 para resposta detalhada, 0 para resposta simples.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.