Microsoft Clarity

Visão geral

O Microsoft Clarity reúne mapas de calor, gravações de sessão e métricas de engajamento no produto. A integração do SquadOS, porém, expõe somente a API de exportação de dados agregados: o agente pode consultar métricas segmentadas por sistema operacional, dispositivo, navegador e outras dimensões, mas não recebe os mapas de calor nem os vídeos das sessões.

• 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.

Use um token dedicado e informe-o somente na página segura hospedada pela Composio. Não coloque o token em prompts, mensagens ou bases de conhecimento. Substitua-o prontamente se um administrador com acesso for removido do projeto ou se houver suspeita de exposição.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Microsoft Clarity.
3. Abra o painel Configurar ferramenta e clique em Ativar. A integração passa para Ativas com o estado Aguardando autenticação.
4. Abra a ferramenta ativa e clique em Conectar agora.
5. Na página segura hospedada pela Composio, informe o token e conclua a conexão.
6. De volta ao SquadOS, confirme a conta em Contas e use Editar ações para revisar a operação disponível.
7. No editor do agente, abra Ferramentas, clique em Adicionar Ferramenta, escolha Microsoft Clarity, selecione a conta e a ação, salve e faça um teste controlado. (Detalhes em Ferramentas da Organização.)

Ações disponíveis

O catálogo atual da Composio contém 1 ação do Microsoft Clarity; o identificador está documentado abaixo. Os parâmetros pertencem ao snapshot 20260407_00, enquanto o catálogo atual está em 20260724_00. Confirme o schema em Editar ações antes de salvar.

Cuidado

A API limita cada projeto a 10 requisições por dia, consulta somente os últimos 1, 2 ou 3 dias, aceita no máximo três dimensões e retorna até 1.000 linhas sem paginação. Planeje cada exportação, evite repetições automáticas e trate 429 como limite diário, não como motivo para retry agressivo. As métricas são agregadas, mas ainda podem revelar padrões sensíveis; aplique a política de privacidade e retenção da organização.

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.