View as Markdown
Mode icon

Mode ACTION

Run Report

Trigger a new run of a report. Returns a run object whose token can be passed to Get Report Run to poll the run state. 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 Run Report 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-run-report",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mode: { authProvisionId: "apn_xxxxxxx" },
    reportToken: "Report Token",
    parameters: "Parameters",
  },
})

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.

Run Report inputs
Property Type Description
reportToken Report Token string
The token of the report. Run the List Reports action to find available report tokens.
Required
parameters Parameters object
Optional custom parameter values for the run, sent as { parameters: { ... } }. Example: {"start_date": "2026-01-01", "region": "us"}.
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-run-report
Version
0.0.2
App
Mode
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes