View as Markdown
Bonusly icon

Bonusly ACTION

Get Company Participation Report

Return company-level recognition participation analytics - giving/receiving rates by group (department, location, etc.) or by manager and team, for a given date range. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Bonusly account once, then configure and run Get Company Participation 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: "bonusly-get-company-participation-report",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bonusly: { authProvisionId: "apn_xxxxxxx" },
    reportView: "Report View",
    startDate: "Start Date",
  },
})

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 Company Participation Report inputs
Property Type Description
reportView Report View string
Which participation view to return.
Required
startDate Start Date string
Start of the report's date range, in YYYY-MM-DD format, e.g. 2026-01-01.
Required
endDate End Date string
End of the report's date range, in YYYY-MM-DD format, e.g. 2026-06-30. Bonusly cannot report on the current or an ongoing month, so this must be no later than the last day of the previous month - for example, any time during August 2026 the latest valid value is 2026-07-31. A later date is rejected.
Required
customPropertyGroup Custom Property Group string
Grouping dimension to break the giving_and_receiving view down by, e.g. department or location. Ignored for the managers_and_teams view.
Optional
includeTrend Include Trend boolean
Set to true to include trend data alongside the current period's metrics.
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
bonusly-get-company-participation-report
Version
0.0.2
App
Bonusly
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes