Get insight with the PostHog API

Returns one insight with its query and result. By default the result comes from the cache, and refresh set to blocking calculates it again when it is stale.

Identifier
posthog_get_insight

The request

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

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
project_idstringYesId of the project: the project_id of a team in List organizations, or the number after /project/ in the URL of PostHog.
insight_idstringYesNumeric id or 8-character short_id of the insight, from List insights, or the short_id after /insights/ in the URL of the insight.
refreshstringNoforce_cache, the default, never calculates. blocking calculates now unless the cached result is fresh, and force_blocking always calculates.Values: force_cache, blocking, force_blocking
filters_overridestringNoJSON object, as text, that overrides the filters for this request only, for example {"date_from":"-30d"}.

Supported connections

Your customer connects their PostHog account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

When connecting, your customer also enters {region}: the address of their account on the app's API.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/posthog_get_insight. It becomes your agent's tool definition with no conversion.

Other PostHog tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.