PostHog tools
The 12 PostHog operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- 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.
- List event definitionsGETLists 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.
- 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.
- List annotationsGETLists the annotations of the project, the notes pinned to a moment on the charts, with id, content, date_marker and scope. Page with limit and offset.
- Create annotationPOSTCreates an annotation, a note shown on the charts at a moment, such as a campaign launch. By default it shows on every chart of the project.
- Update annotationPATCHChanges an annotation. Only the fields sent change. PostHog does not delete annotations: set deleted to true to hide one, or to false to restore it.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
