Microsoft Clarity

Visão geral

O Microsoft Clarity é uma ferramenta gratuita de análise de comportamento de usuário que captura mapas de calor, gravações de sessão e métricas de engajamento para ajudar a melhorar a experiência em sites. Com a integração no SquadOS, seus agentes podem exportar dados analíticos do Clarity — como insights por sistema operacional, dispositivo ou navegador — para relatórios automatizados, análises de funil e tomadas de decisão baseadas em comportamento real de usuários.

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

Autenticação

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
api_key	Sim	Token de acesso gerado nas configurações do projeto Clarity (Settings → Data Export → Generate new API token).

Como obter a credencial

1. Acesse clarity.microsoft.com e faça login com sua conta Microsoft.
2. Selecione o projeto desejado no painel principal.
3. Vá em Settings (Configurações) no menu do projeto.
4. Clique na aba Data Export.
5. Clique em Generate new API token, defina um nome descritivo (entre 4 e 32 caracteres) e confirme.
6. Copie o token gerado — esse é o valor a usar no campo api_key ao conectar no SquadOS.

Dica

Apenas administradores do projeto podem criar e gerenciar tokens de acesso. Se você não vê a aba Data Export, solicite acesso de admin ao dono do projeto.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Microsoft Clarity.
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 token de API obtido 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

Exportar dados

MICROSOFT_CLARITY_DATA_EXPORT

Exporta dados do Microsoft Clarity. Permite obter insights de comportamento de usuário segmentados por até três dimensões (ex.: sistema operacional, dispositivo, navegador), referentes aos últimos 24, 48 ou 72 horas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
numOfDays	integer	Sim	Número de dias para exportação de dados a partir do momento da chamada à API, correspondendo às últimas 24, 48 ou 72 horas, respectivamente.
dimension1	string	Não	Primeira dimensão para segmentar os insights.
dimension2	string	Não	Segunda dimensão para segmentar os insights.
dimension3	string	Não	Terceira dimensão para segmentar os insights.

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.