View as Markdown
PostHog icon

PostHog ACTION

Create Query

Create a HogQLQuery and return the results. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's PostHog account once, then configure and run Create Query from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "posthog-create-query",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    posthog: { authProvisionId: "apn_xxxxxxx" },
    organizationId: "Organization ID",
    projectId: "Project ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Query inputs
Property Type Description
organizationId Organization ID string
Identifier of an organization
Required Dynamic
projectId Project ID string
Identifier of a project
Required Dynamic
query Query string
The query specifying what data to retrieve. Example: select properties.email from persons where properties.email is not null
Required
name Name string
A name for the query to better identify it in the query_log table
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
posthog-create-query
Version
0.0.6
App
PostHog
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes