Voluum (Access Keys) ACTION
Report Data
Return standard report. See the API documentation
- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Voluum (Access Keys) account once, then configure and run Report Data 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: "voluum-report-data",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
voluum: { authProvisionId: "apn_xxxxxxx" },
from: "From (Start Date)",
to: "To (End Date)",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "voluum-report-data",
"configured_props": {
"voluum": { "authProvisionId": "apn_xxxxxxx" },
"from": "From (Start Date)",
"to": "To (End Date)"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "voluum",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "voluum-report-data",
arguments: {
from: "From (Start Date)",
to: "To (End Date)",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
from From (Start Date) | string | Start of the report time range in ISO 8601 format (e.g., 2017-02-20T00:00:00Z) Required |
to To (End Date) | string | End of the report time range in ISO 8601 format (e.g., 2017-02-21T00:00:00Z) Optional |
include Include | string | Type of core entities to include Optional |
compareFrom Compare From | string | Compare from date/time in ISO 8601 format (e.g., 2017-02-20T00:00:00Z) Optional |
compareTo Compare To | string | Compare to date/time in ISO 8601 format (e.g., 2017-02-21T00:00:00Z) Optional |
workspaces Workspaces | string[] | A list of workspace ids to filter by Optional |
conversionTimeMode Conversion Time Mode | string | The mode to use for conversion time Optional |
currency Currency | string | Currency, default value is USD Optional |
tz Timezone | string | Timezone for the report (e.g., Etc/GMT, America/New_York) Optional |
sort Sort | string | Sort column Optional |
direction Direction | string | Sort direction Optional |
maxResults Max Results | integer | Maximum number of results to return 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
- voluum-report-data
- Version
- 0.0.1
- App
- Voluum (Access Keys)
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗