Postmark ACTION
Get Email Platform Usage
Gets an overview of the platforms used to open your emails. This is only recorded when open tracking is enabled for that email. See the documentation
- Action
- Writes data
- Destructive
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Postmark account once, then configure and run Get Email Platform Usage 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: "postmark-get-email-platform-usage",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
postmark: { authProvisionId: "apn_xxxxxxx" },
tag: "Tag",
fromdate: "From 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": "postmark-get-email-platform-usage",
"configured_props": {
"postmark": { "authProvisionId": "apn_xxxxxxx" },
"tag": "Tag",
"fromdate": "From 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": "postmark",
},
},
},
)
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: "postmark-get-email-platform-usage",
arguments: {
tag: "Tag",
fromdate: "From 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 |
|---|---|---|
tag Tag | string | Filter by tag Optional |
fromdate From Date | string | Filter stats starting from the date specified (inclusive). e.g. 2014-01-01 Optional |
todate To Date | string | Filter stats up to the date specified (inclusive). e.g. 2014-02-01 Optional |
messagestream Message Stream | string | Filter by message stream. If not provided, the response will include stats for all streams in the server. 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
- postmark-get-email-platform-usage
- Version
- 0.0.4
- App
- Postmark
- Authentication
- API key
- Read-only
- No
- Destructive
- Yes
- Open world
- Yes
- Source
- View on GitHub ↗