List event definitions with the PostHog API
Lists the events tracked in the project with name, description, tags and last_seen_at, to use in queries and annotations. Page with limit and offset.
- Identifier
- posthog_list_event_definitions
The request
POST https://connect.reportei.com/api/tools/posthog_list_event_definitions/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>"
}
}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
| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | string | Yes | 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 | Case-insensitive match on the event name. Every word has to match. |
| event_type | string | No | event, the default, returns all events. event_custom keeps only names without a $ prefix, and event_posthog only the PostHog events, with the $ prefix.Values: event, event_custom, event_posthog |
| exclude_stale | boolean | No | true leaves out the events not seen in the last 30 days. |
| limit | integer | No | Events per page. The default is 100. |
| offset | integer | No | Index of the first event of the page. |
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_list_event_definitions. It becomes your agent's tool definition with no conversion.
Other PostHog tools
- List organizationsGETLists the organizations the key reaches, each with its projects under teams. The project_id of each team is what the other tools ask for. Page with limit and offset.
- Run queryPOSTRuns an ad hoc analytics query and returns its results, up to 100 rows unless the SQL sets a LIMIT. It is not an export: PostHog refuses OFFSET, limits each project to 3 queries at a time and debits every query from an hourly read budget.
- List insightsGETLists the insights of the project with id, short_id, name, description and query. Unless basic is true, each one also carries its cached result. Page with limit and offset.
- Get insightGETReturns 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.
- List dashboardsGETLists the dashboards of the project with id, name, description, pinned and tags. Page with limit and offset.
- Get dashboardGETReturns one dashboard with its filters and tiles, each tile with its insight and the cached result.
- List personsGETLists the persons of the project with their distinct_ids and properties. search finds them by email, name, person id or distinct id. Page with limit and offset.
- List cohortsGETLists the cohorts of the project with id, name, description, count of persons and whether they are static. Page with limit and offset.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
