Listar personas en PostHog, con una API
Lista las personas del proyecto con sus distinct_ids y propiedades. search las encuentra por email, nombre, id de la persona o distinct id. Pagina con limit y offset.
- Identificador
- posthog_list_persons
La llamada
POST https://connect.reportei.com/api/tools/posthog_list_persons/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>"
}
}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ámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| project_id | string | Sí | Id of the project: the project_id of a team in List organizations, or the number after /project/ in the URL of PostHog. |
| search | string | No | Part of an email address, name, person id or distinct id. |
| string | No | Exact email address of the person. | |
| distinct_id | string | No | Exact distinct id of the person, usually the user id of your own product. |
| limit | integer | No | Persons per page. |
| offset | integer | No | Index of the first person of the page. |
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_list_persons. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de PostHog
- Listar organizacionesGETLista las organizaciones a las que llega la key, cada una con sus proyectos en teams. El project_id de cada team es lo que piden las demás herramientas. Pagina con limit y offset.
- Listar definiciones de eventosGETLista los eventos rastreados en el proyecto con nombre, descripción, tags y last_seen_at, para usar en queries y anotaciones. Pagina con limit y offset.
- Ejecutar queryPOSTEjecuta 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.
- Listar insightsGETLista los insights del proyecto con id, short_id, nombre, descripción y query. Salvo que basic sea true, cada uno también trae su resultado en caché. Pagina con limit y offset.
- Obtener insightGETDevuelve un insight con su query y resultado. Por defecto el resultado viene de la caché, y refresh en blocking lo calcula de nuevo cuando está desactualizado.
- Listar dashboardsGETLista los dashboards del proyecto con id, nombre, descripción, pinned y tags. Pagina con limit y offset.
- Obtener dashboardGETDevuelve un dashboard con sus filtros y tiles, cada tile con su insight y el resultado en caché.
- Listar cohortesGETLista las cohortes del proyecto con id, nombre, descripción, cantidad de personas y si son estáticas. Pagina con limit y offset.
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
