Obter insight no PostHog, por uma API

Retorna um insight com sua query e resultado. Por padrão o resultado vem do cache, e refresh com blocking o calcula de novo quando está desatualizado.

Identificador
posthog_get_insight

A chamada

POST https://connect.reportei.com/api/tools/posthog_get_insight/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>",
    "insight_id": "<insight_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.
insight_idstringSimNumeric id or 8-character short_id of the insight, from List insights, or the short_id after /insights/ in the URL of the insight.
refreshstringNãoforce_cache, the default, never calculates. blocking calculates now unless the cached result is fresh, and force_blocking always calculates.Valores: force_cache, blocking, force_blocking
filters_overridestringNãoJSON object, as text, that overrides the filters for this request only, for example {"date_from":"-30d"}.

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