Pular para o conteúdo

PostHog

PostHog

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.

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

Você vai precisar dos seguintes campos:

CampoObrigatórioDescrição
api_keySimChave de API pessoal gerada no painel PostHog em Settings → Personal API Keys.
  1. Acesse posthog.com e faça login ou crie uma conta.
  2. Clique em Settings no canto superior direito.
  3. Role a página até encontrar a seção Personal API Keys.
  4. Antes de gerar a chave, defina os escopos (permissões) que a aplicação precisará — restrinja ao mínimo necessário para segurança.
  5. Forneça um nome descritivo para a chave e clique em Create.
  6. Copie a chave imediatamente — ela é exibida apenas uma vez após a criação.
  1. Acesse Ferramentas no menu lateral (/admin/tools).
  2. Abra a aba Disponíveis e procure por PostHog.
  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 a chave de API obtida 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.)

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.

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.

NomeTipoObrigatórioDescrição
eventstringSimNome do evento a capturar (ex.: lesson_started, quiz_completed, button_clicked).
api_keystringSimChave de API do projeto (write-only de ingestão). É diferente da chave pessoal e segura para uso em contextos públicos.
timestampstringNãoTimestamp 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.
propertiesobjectNãoPropriedades opcionais do evento com metadados arbitrários (ex.: {'lesson_id': '42', 'score': 95}).
distinct_idstringSimIdentificador único do usuário ou entidade. Geralmente um UUID ou ID de usuário (ex.: 018daf23-89b3-7cf8-a4f1-94064c96df90 ou user_123).
ingest_hoststringNãoHost 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.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
keystringSimChave 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.
namestringNãoNome legível do feature flag exibido na UI do PostHog. Se omitido, usa o valor de key.
tagsarrayNãoLista de tags para organizar o feature flag (ex.: ['frontend', 'experiment']).
activebooleanNãoSe o feature flag está ativo/habilitado. Defina como false para desabilitar sem deletar. Padrão: true.
deletedbooleanNãoSe o feature flag está soft-deletado. Flags soft-deletados ficam ocultos mas podem ser restaurados.
filtersobjectNãoConfiguraçã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_idstringSimID do projeto onde o feature flag será criado. Encontre-o via List All Projects ou nas configurações do projeto PostHog.
is_simple_flagbooleanNãoSe 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_continuitybooleanNãoSe true, garante que os usuários vejam a mesma experiência mesmo que as configurações do flag mudem. Útil em testes A/B.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
idintegerSimValor inteiro único identificando o feature flag.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
idintegerSimValor inteiro único identificando o feature flag.
keystringSimChave do flag.
namestringNãoDescrição do flag (campo name mantido por retrocompatibilidade).
tagsarrayNãoTags do flag.
activebooleanNãoSe o flag está ativo.
deletedbooleanNãoSe o flag está deletado.
filtersobjectNãoFiltros de segmentação e rollout.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
rollout_percentageintegerNãoPercentual de rollout (0–100).
ensure_experience_continuitybooleanNãoGarante continuidade de experiência ao usuário.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
idsarrayNãoLista explícita de IDs de feature flags a deletar. Mutuamente exclusivo com filters.
filtersobjectNãoCritérios de filtro para selecionar flags para exclusão. Suporta os mesmos parâmetros do endpoint de listagem. Mutuamente exclusivo com ids.
project_idstringSimID do projeto. Use @current para o projeto atual ou informe o ID numérico.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
namestringNãoNome de exibição do insight.
tagsarrayNãoLista de tags para categorizar e organizar o insight (ex.: ['conversão', 'cadastro']).
querystringNãoObjeto 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.
savedbooleanNãoSe true, salva o insight permanentemente. false para insights temporários.
formatstringNãoFormato da resposta: json ou csv. Padrão: json.
deletedbooleanNãoSoft delete: marca o insight como deletado sem remover do banco.
timezonestringNãoFuso horário para exibição dos dados (ex.: UTC, America/New_York).
favoritedbooleanNãoSe true, marca o insight como favorito.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
descriptionstringNãoDescrição detalhada do que o insight mede ou analisa.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero de resultados a retornar. Use para paginação.
formatstringNãoFormato da resposta: csv ou json. Padrão: json.
offsetintegerNãoNúmero de resultados a pular. Use para paginação.
short_idstringNãoShort ID de um insight salvo específico a recuperar. Se omitido, retorna todos os insights de tendência do projeto.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
eventsarrayNãoLista 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.
formatstringNãoFormato da resposta: json ou csv.
actionsarrayNãoLista de ações a incluir no funil. Cada ação deve ter id, type (actions) e order.
date_tostringNãoData de fim da análise. Pode ser uma data (2021-01-01) ou relativa (-7d, -1m, mStart, yStart).
date_fromstringNãoData de início da análise. Pode ser uma data ou relativa.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
filter_test_accountsbooleanNãoSe deve filtrar contas internas e de teste.
funnel_window_intervalintegerNãoTamanho da janela de conversão do funil (usado com funnel_window_interval_type).
funnel_window_interval_typestringNãoUnidade para o intervalo da janela: day, hour, minute, week ou month.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
namestringSimNome do experimento.
feature_flag_keystringSimChave do feature flag associado ao experimento.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
descriptionstringNãoDescrição do experimento.
start_datestringNãoData de início do experimento.
end_datestringNãoData de fim do experimento.
filtersstringNãoFiltros do experimento.
parametersstringNãoParâmetros de configuração do experimento.
secondary_metricsstringNãoMétricas secundárias do experimento.
archivedbooleanNãoSe o experimento está arquivado.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
idintegerSimValor inteiro único identificando o experimento.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
idintegerSimValor inteiro único identificando o experimento.
feature_flag_keystringSimChave do feature flag (obrigatória para atualização).
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
namestringNãoNome do experimento.
descriptionstringNãoDescrição do experimento.
start_datestringNãoData de início.
end_datestringNãoData de fim.
parametersstringNãoParâmetros do experimento.
secondary_metricsstringNãoMétricas secundárias.
archivedbooleanNãoSe o experimento está arquivado.
exposure_cohortintegerNãoCohort de exposição.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
namestringSimNome do cohort.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
groupsstringNãoGrupos que definem os critérios do cohort dinâmico.
filtersstringNãoFiltros do cohort.
is_staticbooleanNãoSe true, cria um cohort estático.
descriptionstringNãoDescrição do cohort.
deletedbooleanNãoSoft delete do cohort.
querystringNãoQuery do cohort.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero de resultados a retornar por página.
offsetintegerNãoÍndice inicial para retornar os resultados.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
idstringSimValor UUID único identificando esta pessoa.
formatstringNãoFormato da resposta: csv ou json.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
idstringSimIdentificador da pessoa.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
propertiesstringNãoPropriedades a atualizar no formato JSON.
namestringNãoNome da pessoa.
uuidstringNãoUUID da pessoa.
formatstringNãoFormato da resposta: csv ou json.
distinct_idsarrayNãoIDs distintos associados à pessoa.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
namestringSimNome da survey.
typestringSimTipo da survey: popover, widget ou api.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
questionsstringNãoArray 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.
descriptionstringNãoDescrição da survey.
start_datestringNãoData de início da survey.
end_datestringNãoData de fim da survey.
linked_flag_idintegerNãoID do feature flag vinculado à survey.
targeting_flag_idintegerNãoID do flag de segmentação.
responses_limitintegerNãoLimite máximo de respostas.
archivedbooleanNãoSe a survey está arquivada.
appearancestringNãoConfigurações de aparência.
conditionsstringNãoCondições de exibição.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
idstringSimString UUID identificando esta survey.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
idstringSimString UUID identificando esta survey.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
question_indexintegerSimÍndice da pergunta a sumarizar as respostas (índice base 0).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

POSTHOG_CREATE_PROJECT_DASHBOARD

Cria um dashboard dentro de um projeto usando project_id. Retorna HTTP 201 com os detalhes do dashboard criado.

NomeTipoObrigatórioDescrição
namestringSimNome do dashboard.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
tagsarrayNãoLista de tags para categorizar o dashboard (ex.: ['analytics', 'revenue', 'weekly']).
descriptionstringNãoDescrição do dashboard.
pinnedbooleanNãoSe o dashboard está fixado.
deletedbooleanNãoSe o dashboard está deletado.
filtersstringNãoFiltros a nível de dashboard como objeto JSON (ex.: {'date_from': '-7d', 'date_to': null}).
use_templatestringNãoID do template a usar para criar o dashboard.
use_dashboardintegerNãoID de um dashboard existente para duplicar.
restriction_levelintegerNãoNível de controle de acesso: 21 (todos no projeto), 37 (apenas o criador).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
idintegerSimValor inteiro único identificando o dashboard.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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

NomeTipoObrigatórioDescrição
namestringSimNome da playlist de gravações de sessão.
typestringSimTipo da playlist: filters (dinâmica, baseada em filtros) ou collection (coleção curada manualmente).
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
pinnedbooleanNãoSe a playlist deve ser fixada no topo da lista.
deletedbooleanNãoSoft delete: marca a playlist como deletada.
filtersstringNãoConfiguração de filtros para playlists do tipo filters. Pode incluir eventos, duração, intervalos de data e combinações de filtros complexos.
descriptionstringNãoDescrição opcional da playlist.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
idstringSimString UUID identificando esta gravação de sessão.
project_idstringSimID do projeto. Para encontrar o ID, chame /api/projects/.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
namestringSimNome legível para esta exportação em lote.
intervalstringSimFrequência de execução da exportação: hour, day, week ou every 5 minutes.
destinationobjectSimConfiguração especificando para onde e como os dados devem ser exportados.
project_idstringSimID do projeto onde a exportação será criada. Para encontrar o ID, chame /api/projects/.
modelstringNãoModelos de dados para exportação em lote: events, persons ou sessions.
end_atstringNãoTimestamp ISO 8601 para quando as exportações devem parar (ex.: 2024-12-31T23:59:59Z).
pausedbooleanNãoSe true, cria a exportação em estado pausado. Padrão: false.
schemaobjectNãoConfiguração de schema personalizado definindo quais campos exportar.
filtersobjectNãoFiltros para especificar quais dados exportar.
start_atstringNãoTimestamp ISO 8601 para quando as exportações devem começar.
timezonestringNãoFuso horário para agendamento das exportações (ex.: America/New_York, UTC).
hogql_querystringNãoQuery HogQL opcional para filtrar ou transformar os dados exportados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

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.

NomeTipoObrigatórioDescrição
uuidstringSimIdentificador 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.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.