View as Markdown
Mode icon

Mode ACTION

Create Query

Create a new query in a report. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mode 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: "mode-create-query",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mode: { authProvisionId: "apn_xxxxxxx" },
    reportToken: "Report Token",
    dataSourceId: 10,
  },
})

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
reportToken Report Token string
The token of the report. Run the List Reports action to find available report tokens.
Required
dataSourceId Data Source ID integer
The integer id of the data source, e.g. 1234567 (the id field, NOT the token). Run the List Data Sources action to find available data source ids.
Required
rawQuery Raw Query string
The raw SQL query text. Example: SELECT * FROM orders LIMIT 100.
Required
name Name string
Optional name for the query.
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
mode-create-query
Version
0.0.1
App
Mode
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes