Exécuter une requête avec l'API PostHog

Exécute une requête d'analytics ad hoc et renvoie ses résultats, jusqu'à 100 lignes sauf si le SQL définit un LIMIT. Ce n'est pas un export : PostHog refuse OFFSET, limite chaque projet à 3 requêtes simultanées et débite chaque requête d'un budget de lecture horaire.

Identifiant
posthog_run_query

L'appel

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": {}
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
project_idstringOuiId of the project: the project_id of a team in List organizations, or the number after /project/ in the URL of PostHog.
queryobjectOuiThe 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.
namestringNonShort name of the query, shown in the query log of the project.
refreshstringNonblocking, the default, calculates now unless fresh results are cached. force_blocking always calculates, and force_cache only returns cached results.Valeurs : blocking, force_blocking, force_cache

Connexions possibles

Votre client connecte son compte PostHog une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

À la connexion, votre client indique aussi {region} : l'adresse de son compte sur l'API de l'app.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/posthog_run_query. Il devient la définition de tool de votre agent sans conversion.

Autres tools PostHog

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.