View as Markdown
Mode icon

Mode ACTION

Get Report Run

Retrieve a single report run, including its state (pending, enqueued, running_notebook, succeeded, failed, cancelled, completed). Use this to poll a run triggered by Run 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 Report Run 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-report-run",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mode: { authProvisionId: "apn_xxxxxxx" },
    reportToken: "Report Token",
    runToken: "Run 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 Report Run inputs
Property Type Description
reportToken Report Token string
The token of the report. Run the List Reports action to find available report tokens.
Required
runToken Run Token string
The token of the run to retrieve, e.g. 9fabcf384694. Returned in the token field by the Run Report action or List Report Runs.
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-report-run
Version
0.0.2
App
Mode
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes