Ejecutar query en PostHog, con una API

Ejecuta una query de analítica ad hoc y devuelve sus resultados, hasta 100 filas salvo que el SQL defina un LIMIT. No es una exportación: PostHog rechaza OFFSET, limita cada proyecto a 3 queries a la vez y descuenta cada query de un presupuesto de lectura por hora.

Identificador
posthog_run_query

La llamada

POST https://connect.reportei.com/api/tools/posthog_run_query/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>",
    "query": {}
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
project_idstringSíId of the project: the project_id of a team in List organizations, or the number after /project/ in the URL of PostHog.
queryobjectSíThe query. kind HogQLQuery runs the SQL of query over tables such as events, persons and sessions. The insight kinds, such as TrendsQuery, FunnelsQuery and RetentionQuery, take their own fields here instead, for example series and dateRange.
namestringNoShort name of the query, shown in the query log of the project.
refreshstringNoblocking, the default, calculates now unless fresh results are cached. force_blocking always calculates, and force_cache only returns cached results.Valores: blocking, force_blocking, force_cache

Conexiones posibles

Tu cliente conecta su cuenta de PostHog una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

Al conectar, tu cliente también indica {region}: la dirección de su cuenta en la API de la app.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/posthog_run_query. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de PostHog

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.