View as Markdown
Mode icon

Mode ACTION

Get Query

Retrieve a single query within a report. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mode account once, then configure and run Get 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-get-query",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mode: { authProvisionId: "apn_xxxxxxx" },
    reportToken: "Report Token",
    queryToken: "Query Token",
  },
})

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.

Get 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
queryToken Query Token string
The token of the query within a report. Run the List Queries action to find available query tokens.
Required

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-get-query
Version
0.0.1
App
Mode
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes