Listar insights no PostHog, por uma API

Lista os insights do projeto com id, short_id, nome, descrição e query. A menos que basic seja true, cada um também traz seu resultado em cache. Pagine com limit e offset.

Identificador
posthog_list_insights

A chamada

POST https://connect.reportei.com/api/tools/posthog_list_insights/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "project_id": "<project_id>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
project_idstringSimId of the project: the project_id of a team in List organizations, or the number after /project/ in the URL of PostHog.
searchstringNãoText matched against the name, description and tags.
savedbooleanNãotrue returns only saved insights.
insightstringNãoOnly insights of this type.Valores: TRENDS, FUNNELS, RETENTION, PATHS, STICKINESS, LIFECYCLE, SQL
basicbooleanNãotrue returns only the metadata, without results, which is faster.
limitintegerNãoInsights per page.
offsetintegerNãoIndex of the first insight of the page.

Conexões possíveis

O seu cliente conecta a conta do PostHog uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

Na conexão, o cliente informa também {region}: o endereço da conta dele na API do app.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/posthog_list_insights. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do PostHog

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.