PostHog
Visão geral
Seção intitulada “Visão geral”PostHog é uma plataforma open-source de analytics de produto que rastreia interações e comportamentos dos usuários para ajudar equipes a aprimorar funcionalidades, melhorar funis de conversão e reduzir churn. Com a integração PostHog no SquadOS, seus agentes podem capturar eventos, gerenciar feature flags, disparar experimentos A/B, analisar cohorts, criar surveys e monitorar dados exportados — tudo via API.
- Site oficial: https://posthog.com/
- Documentação na Composio: docs.composio.dev/toolkits/posthog
Autenticação
Seção intitulada “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 | Chave de API pessoal gerada no painel PostHog em Settings → Personal API Keys. |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Acesse posthog.com e faça login ou crie uma conta.
- Clique em Settings no canto superior direito.
- Role a página até encontrar a seção Personal API Keys.
- Antes de gerar a chave, defina os escopos (permissões) que a aplicação precisará — restrinja ao mínimo necessário para segurança.
- Forneça um nome descritivo para a chave e clique em Create.
- Copie a chave imediatamente — ela é exibida apenas uma vez após a criação.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
PostHog. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
- 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.)
Perguntas frequentes
Seção intitulada “Perguntas frequentes”Como configurar credenciais OAuth personalizadas para o PostHog?
Seção intitulada “Como configurar credenciais OAuth personalizadas para o PostHog?”Para um guia passo a passo sobre como criar e configurar suas próprias credenciais OAuth do PostHog com a Composio, consulte How to create OAuth credentials for PostHog.
Ações disponíveis
Seção intitulada “Ações disponíveis”Capturar evento
Seção intitulada “Capturar evento”POSTHOG_CAPTURE_EVENT
Captura (ingere) um único evento de analytics no PostHog usando a API pública de ingestão e uma chave de API de projeto. Use quando precisar enviar eventos personalizados como lesson_started, quiz_completed ou qualquer rastreamento de comportamento do usuário. Este endpoint bypassa os endpoints privados /api/* e usa o endpoint público write-only de ingestão do PostHog.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
event | string | Sim | Nome do evento a capturar (ex.: lesson_started, quiz_completed, button_clicked). |
api_key | string | Sim | Chave de API do projeto (write-only de ingestão). É diferente da chave pessoal e segura para uso em contextos públicos. |
timestamp | string | Não | Timestamp ISO 8601 indicando quando o evento ocorreu (ex.: 2024-05-22T17:09:29.220Z). Se omitido, o PostHog usa o horário atual do servidor. |
properties | object | Não | Propriedades opcionais do evento com metadados arbitrários (ex.: {'lesson_id': '42', 'score': 95}). |
distinct_id | string | Sim | Identificador único do usuário ou entidade. Geralmente um UUID ou ID de usuário (ex.: 018daf23-89b3-7cf8-a4f1-94064c96df90 ou user_123). |
ingest_host | string | Não | Host de ingestão do PostHog. Use https://us.i.posthog.com para US Cloud, https://eu.i.posthog.com para EU Cloud, ou seu domínio self-hosted. Padrão: US Cloud. |
| 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 feature flag
Seção intitulada “Criar feature flag”POSTHOG_CREATE_FEATURE_FLAG
Cria um novo feature flag em um projeto PostHog. Use quando precisar adicionar toggles de funcionalidades, realizar rollouts graduais ou direcionar segmentos específicos de usuários sem fazer novo deploy.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
key | string | Sim | Chave identificadora única do feature flag (ex.: dark-mode, new-checkout-flow). Usada no código para verificar se o flag está ativo. Deve ser única no projeto. |
name | string | Não | Nome legível do feature flag exibido na UI do PostHog. Se omitido, usa o valor de key. |
tags | array | Não | Lista de tags para organizar o feature flag (ex.: ['frontend', 'experiment']). |
active | boolean | Não | Se o feature flag está ativo/habilitado. Defina como false para desabilitar sem deletar. Padrão: true. |
deleted | boolean | Não | Se o feature flag está soft-deletado. Flags soft-deletados ficam ocultos mas podem ser restaurados. |
filters | object | Não | Configuração de filtragem e rollout. Estrutura: {'groups': [{'properties': [], 'rollout_percentage': 50}]}. Use rollout_percentage (0–100) para rollout gradual. Se omitido, o flag fica ativo para todos os usuários. |
project_id | string | Sim | ID do projeto onde o feature flag será criado. Encontre-o via List All Projects ou nas configurações do projeto PostHog. |
is_simple_flag | boolean | Não | Se true, cria um flag booleano simples (liga/desliga). Se false, habilita opções avançadas de segmentação e multivariante. Padrão: true. |
ensure_experience_continuity | boolean | Não | Se true, garante que os usuários vejam a mesma experiência mesmo que as configurações do flag mudem. Útil em testes A/B. |
| 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 detalhes de feature flag
Seção intitulada “Consultar detalhes de feature flag”POSTHOG_GET_FEATURE_FLAG_DETAILS
Recupera informações detalhadas de um feature flag específico em um projeto PostHog, incluindo configuração de filtros, percentuais de rollout, status, histórico de criação/modificação, experimentos associados, surveys e configurações de acesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | Valor inteiro único identificando o feature flag. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
| 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 configuração de feature flag
Seção intitulada “Atualizar configuração de feature flag”POSTHOG_UPDATE_FEATURE_FLAG
Gerencia feature flags com opções de criação, leitura, atualização e exclusão. Utilize a biblioteca JS do PostHog ou o endpoint para verificar o status do flag.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | Valor inteiro único identificando o feature flag. |
key | string | Sim | Chave do flag. |
name | string | Não | Descrição do flag (campo name mantido por retrocompatibilidade). |
tags | array | Não | Tags do flag. |
active | boolean | Não | Se o flag está ativo. |
deleted | boolean | Não | Se o flag está deletado. |
filters | object | Não | Filtros de segmentação e rollout. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
rollout_percentage | integer | Não | Percentual de rollout (0–100). |
ensure_experience_continuity | boolean | Não | Garante continuidade de experiência ao usuário. |
| 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 feature flags em lote
Seção intitulada “Excluir feature flags em lote”POSTHOG_BULK_DELETE_FEATURE_FLAGS
Exclui feature flags em lote por critério de filtro ou IDs explícitos. Aceita filters (mesmos parâmetros do endpoint de listagem: search, active, type, etc.) ou ids (lista explícita de IDs). Retorna o status da operação e a contagem de flags deletados. Use @current como project_id para o projeto atual.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ids | array | Não | Lista explícita de IDs de feature flags a deletar. Mutuamente exclusivo com filters. |
filters | object | Não | Critérios de filtro para selecionar flags para exclusão. Suporta os mesmos parâmetros do endpoint de listagem. Mutuamente exclusivo com ids. |
project_id | string | Sim | ID do projeto. Use @current para o projeto atual ou informe o ID numérico. |
| 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 insight de analytics personalizado
Seção intitulada “Criar insight de analytics personalizado”POSTHOG_CREATE_CUSTOM_PROJECT_INSIGHTS
Cria insights de analytics personalizados para um projeto PostHog. Tipos de query suportados (via InsightVizNode.source.kind): TrendsQuery, FunnelsQuery, RetentionQuery, PathsQuery, StickinessQuery, LifecycleQuery, WebStatsTableQuery, WebOverviewQuery. Para queries HogQL ad-hoc, use POSTHOG_CREATE_QUERY_IN_PROJECT_BY_ID.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Nome de exibição do insight. |
tags | array | Não | Lista de tags para categorizar e organizar o insight (ex.: ['conversão', 'cadastro']). |
query | string | Não | Objeto de configuração da query definindo o tipo e os dados a analisar. Deve ter kind: InsightVizNode e source com um dos 8 tipos válidos. |
saved | boolean | Não | Se true, salva o insight permanentemente. false para insights temporários. |
format | string | Não | Formato da resposta: json ou csv. Padrão: json. |
deleted | boolean | Não | Soft delete: marca o insight como deletado sem remover do banco. |
timezone | string | Não | Fuso horário para exibição dos dados (ex.: UTC, America/New_York). |
favorited | boolean | Não | Se true, marca o insight como favorito. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
description | string | Não | Descrição detalhada do que o insight mede ou analisa. |
| 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 insights de tendência do projeto
Seção intitulada “Consultar insights de tendência do projeto”POSTHOG_RETRIEVE_PROJECT_TREND_INSIGHTS
Recupera insights de tendência salvos de um projeto PostHog. Retorna uma lista de todos os insights de tendência ou um insight específico por short_id. Suporta paginação via limit/offset e formatos de saída CSV/JSON.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | Não | Número de resultados a retornar. Use para paginação. |
format | string | Não | Formato da resposta: csv ou json. Padrão: json. |
offset | integer | Não | Número de resultados a pular. Use para paginação. |
short_id | string | Não | Short ID de um insight salvo específico a recuperar. Se omitido, retorna todos os insights de tendência do projeto. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
| 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 insights de funil do projeto
Seção intitulada “Consultar insights de funil do projeto”POSTHOG_GET_FUNNEL_INSIGHTS_IN_PROJECT
Executa uma análise de funil para um projeto específico. Requer pelo menos 2 etapas via parâmetros events ou actions. Retorna dados de conversão mostrando como os usuários progridem pelo funil. Suporta saída em JSON/CSV.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
events | array | Não | Lista de eventos a incluir no funil. Cada evento deve ter id (nome do evento), type (events) e order (número do passo, iniciando em 0). Mínimo de 2 etapas. |
format | string | Não | Formato da resposta: json ou csv. |
actions | array | Não | Lista de ações a incluir no funil. Cada ação deve ter id, type (actions) e order. |
date_to | string | Não | Data de fim da análise. Pode ser uma data (2021-01-01) ou relativa (-7d, -1m, mStart, yStart). |
date_from | string | Não | Data de início da análise. Pode ser uma data ou relativa. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
filter_test_accounts | boolean | Não | Se deve filtrar contas internas e de teste. |
funnel_window_interval | integer | Não | Tamanho da janela de conversão do funil (usado com funnel_window_interval_type). |
funnel_window_interval_type | string | Não | Unidade para o intervalo da janela: day, hour, minute, week ou month. |
| 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 experimento no projeto
Seção intitulada “Criar experimento no projeto”POSTHOG_CREATE_PROJECT_EXPERIMENT
Cria um novo experimento em um projeto específico. Requer project_id e os detalhes do experimento. Retorna 201 com as informações do experimento criado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do experimento. |
feature_flag_key | string | Sim | Chave do feature flag associado ao experimento. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
description | string | Não | Descrição do experimento. |
start_date | string | Não | Data de início do experimento. |
end_date | string | Não | Data de fim do experimento. |
filters | string | Não | Filtros do experimento. |
parameters | string | Não | Parâmetros de configuração do experimento. |
secondary_metrics | string | Não | Métricas secundárias do experimento. |
archived | boolean | Não | Se o experimento está arquivado. |
| 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 detalhes de experimento
Seção intitulada “Consultar detalhes de experimento”POSTHOG_GET_EXPERIMENT_DETAILS
Acessa informações detalhadas de um experimento dentro de um projeto usando experiment_id e project_id. A resposta inclui datas, chave do feature flag, métricas e detalhes do criador.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | Valor inteiro único identificando o experimento. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
| 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 detalhes de experimento
Seção intitulada “Atualizar detalhes de experimento”POSTHOG_UPDATE_EXPERIMENT
Atualiza um experimento enviando uma requisição PUT com project_id e id. Permite alterar nome, descrição, datas, etc. Requer permissão experiment:write.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | Valor inteiro único identificando o experimento. |
feature_flag_key | string | Sim | Chave do feature flag (obrigatória para atualização). |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
name | string | Não | Nome do experimento. |
description | string | Não | Descrição do experimento. |
start_date | string | Não | Data de início. |
end_date | string | Não | Data de fim. |
parameters | string | Não | Parâmetros do experimento. |
secondary_metrics | string | Não | Métricas secundárias. |
archived | boolean | Não | Se o experimento está arquivado. |
exposure_cohort | integer | Não | Cohort de exposição. |
| 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 cohort no projeto
Seção intitulada “Criar cohort no projeto”POSTHOG_CREATE_PROJECT_COHORT
Cria cohorts para um projeto especificado. Suporta cohorts dinâmicos (via groups ou filters) e estáticos (is_static: true). Retorna 201 com os dados do cohort criado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do cohort. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
groups | string | Não | Grupos que definem os critérios do cohort dinâmico. |
filters | string | Não | Filtros do cohort. |
is_static | boolean | Não | Se true, cria um cohort estático. |
description | string | Não | Descrição do cohort. |
deleted | boolean | Não | Soft delete do cohort. |
query | string | Não | Query do cohort. |
| 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 cohorts do projeto com paginação
Seção intitulada “Listar cohorts do projeto com paginação”POSTHOG_RETRIEVE_PROJECT_COHORTS_WITH_PAGINATION
Recupera uma lista paginada de cohorts de um projeto específico usando project_id. Suporta limit e offset para personalizar a resposta. Requer permissão cohort:read.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | Não | Número de resultados a retornar por página. |
offset | integer | Não | Índice inicial para retornar os resultados. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
| 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 detalhes de pessoa por ID
Seção intitulada “Consultar detalhes de pessoa por ID”POSTHOG_RETRIEVE_PERSON_DETAILS_BY_ID
Recupera os detalhes de uma pessoa específica por UUID. Para criar ou atualizar pessoas, use a API de captura com propriedades $set e $unset ou os SDKs do PostHog.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Valor UUID único identificando esta pessoa. |
format | string | Não | Formato da resposta: csv ou json. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
| 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 propriedades de pessoa
Seção intitulada “Atualizar propriedades de pessoa”POSTHOG_UPDATE_PERSON_PROPERTIES
Atualiza as propriedades listadas de uma pessoa usando o evento $set, sem afetar outras propriedades. Para remover propriedades, use o endpoint delete_property.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Identificador da pessoa. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
properties | string | Não | Propriedades a atualizar no formato JSON. |
name | string | Não | Nome da pessoa. |
uuid | string | Não | UUID da pessoa. |
format | string | Não | Formato da resposta: csv ou json. |
distinct_ids | array | Não | IDs distintos associados à pessoa. |
| 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 survey no projeto
Seção intitulada “Criar survey no projeto”POSTHOG_CREATE_PROJECT_SURVEY
Cria surveys em um projeto fornecendo project_id e detalhes como tipo, perguntas e alvos. Suporta tipos de pergunta aberta, com link, de avaliação (rating) e de múltipla escolha, cada um com lógica de ramificação configurável.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da survey. |
type | string | Sim | Tipo da survey: popover, widget ou api. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
questions | string | Não | Array de perguntas da survey. Cada pergunta deve ser do tipo open, link, rating, single_choice ou multiple_choice, com opções de branching configuráveis. |
description | string | Não | Descrição da survey. |
start_date | string | Não | Data de início da survey. |
end_date | string | Não | Data de fim da survey. |
linked_flag_id | integer | Não | ID do feature flag vinculado à survey. |
targeting_flag_id | integer | Não | ID do flag de segmentação. |
responses_limit | integer | Não | Limite máximo de respostas. |
archived | boolean | Não | Se a survey está arquivada. |
appearance | string | Não | Configurações de aparência. |
conditions | string | Não | Condições de exibição. |
| 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 detalhes de survey por UUID
Seção intitulada “Consultar detalhes de survey por UUID”POSTHOG_RETRIEVE_SURVEY_DETAILS_WITH_UUID_AND_PROJECT_ID
Recupera detalhes de uma survey usando seu UUID e o ID do projeto associado. Retorna nome, tipo, flags vinculados, flags de segmentação, informações do criador e perguntas com descrições de lógica de ramificação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | String UUID identificando esta survey. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
| 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 contagem de respostas de surveys
Seção intitulada “Consultar contagem de respostas de surveys”POSTHOG_RETRIEVE_SURVEY_RESPONSES_COUNT_BY_PROJECT_ID
Recupera a contagem de respostas de surveys de um projeto específico por ID. Retorna detalhes como tipo da survey, flags vinculados e informações do criador.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
| 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. |
Resumir respostas de survey com IA
Seção intitulada “Resumir respostas de survey com IA”POSTHOG_SUMMARIZE_SURVEY_RESPONSES
Gera um resumo com IA das respostas de survey para uma pergunta específica. Use quando precisar analisar e sumarizar feedbacks de respondentes para uma pergunta particular.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | String UUID identificando esta survey. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
question_index | integer | Sim | Índice da pergunta a sumarizar as respostas (índice base 0). |
| 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 dashboard no projeto
Seção intitulada “Criar dashboard no projeto”POSTHOG_CREATE_PROJECT_DASHBOARD
Cria um dashboard dentro de um projeto usando project_id. Retorna HTTP 201 com os detalhes do dashboard criado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do dashboard. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
tags | array | Não | Lista de tags para categorizar o dashboard (ex.: ['analytics', 'revenue', 'weekly']). |
description | string | Não | Descrição do dashboard. |
pinned | boolean | Não | Se o dashboard está fixado. |
deleted | boolean | Não | Se o dashboard está deletado. |
filters | string | Não | Filtros a nível de dashboard como objeto JSON (ex.: {'date_from': '-7d', 'date_to': null}). |
use_template | string | Não | ID do template a usar para criar o dashboard. |
use_dashboard | integer | Não | ID de um dashboard existente para duplicar. |
restriction_level | integer | Não | Nível de controle de acesso: 21 (todos no projeto), 37 (apenas o criador). |
| 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 detalhes de dashboard específico
Seção intitulada “Consultar detalhes de dashboard específico”POSTHOG_RETRIEVE_SPECIFIC_PROJECT_DASHBOARD_DETAILS
Recupera detalhes de um dashboard específico dentro de um projeto. Requer ID do dashboard e ID do projeto. Retorna propriedades, dono e níveis de acesso do dashboard.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | Valor inteiro único identificando o dashboard. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
| 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 playlist de gravações de sessão
Seção intitulada “Criar playlist de gravações de sessão”POSTHOG_CREATE_SESSION_RECORDING_PLAYLIST
Cria playlists de gravações de sessão para um projeto especificado. Suporta playlists dinâmicas baseadas em filtros (type: filters) ou coleções curadas manualmente (type: collection).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da playlist de gravações de sessão. |
type | string | Sim | Tipo da playlist: filters (dinâmica, baseada em filtros) ou collection (coleção curada manualmente). |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
pinned | boolean | Não | Se a playlist deve ser fixada no topo da lista. |
deleted | boolean | Não | Soft delete: marca a playlist como deletada. |
filters | string | Não | Configuração de filtros para playlists do tipo filters. Pode incluir eventos, duração, intervalos de data e combinações de filtros complexos. |
description | string | Não | Descrição opcional da playlist. |
| 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 detalhes de gravação de sessão
Seção intitulada “Consultar detalhes de gravação de sessão”POSTHOG_RETRIEVE_SESSION_RECORDING_DETAILS
Recupera informações detalhadas sobre uma gravação de sessão específica fornecendo o UUID da sessão e o ID do projeto associado. A resposta inclui métricas como duração, atividade, timestamps e dados do usuário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | String UUID identificando esta gravação de sessão. |
project_id | string | Sim | ID do projeto. Para encontrar o ID, chame /api/projects/. |
| 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 exportação em lote
Seção intitulada “Criar exportação em lote”POSTHOG_CREATE_BATCH_EXPORT
Cria uma nova exportação em lote para exportar automaticamente dados do PostHog para destinos externos como S3, BigQuery ou Snowflake. Use quando precisar configurar exportações agendadas com intervalos configuráveis e configurações específicas de destino.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome legível para esta exportação em lote. |
interval | string | Sim | Frequência de execução da exportação: hour, day, week ou every 5 minutes. |
destination | object | Sim | Configuração especificando para onde e como os dados devem ser exportados. |
project_id | string | Sim | ID do projeto onde a exportação será criada. Para encontrar o ID, chame /api/projects/. |
model | string | Não | Modelos de dados para exportação em lote: events, persons ou sessions. |
end_at | string | Não | Timestamp ISO 8601 para quando as exportações devem parar (ex.: 2024-12-31T23:59:59Z). |
paused | boolean | Não | Se true, cria a exportação em estado pausado. Padrão: false. |
schema | object | Não | Configuração de schema personalizado definindo quais campos exportar. |
filters | object | Não | Filtros para especificar quais dados exportar. |
start_at | string | Não | Timestamp ISO 8601 para quando as exportações devem começar. |
timezone | string | Não | Fuso horário para agendamento das exportações (ex.: America/New_York, UTC). |
hogql_query | string | Não | Query HogQL opcional para filtrar ou transformar os dados exportados. |
| 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 perfil de usuário e detalhes de equipe
Seção intitulada “Consultar perfil de usuário e detalhes de equipe”POSTHOG_RETRIEVE_USER_PROFILE_AND_TEAM_DETAILS
Recupera informações do perfil do usuário, incluindo equipe, organização e notificações. Usuários não-staff só podem recuperar seu próprio perfil usando @me como parâmetro uuid. Usuários staff podem recuperar o perfil de qualquer usuário via UUID real. Retorna JSON com nome, email, equipes, organizações e status.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
uuid | string | Sim | Identificador do usuário. Use @me para recuperar o perfil do usuário autenticado atual (recomendado para não-staff). Usuários staff podem usar um UUID real para recuperar perfis de outros usuários. |
| 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. |