# Get Company Participation Report — Bonusly

> 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

- Key: `bonusly-get-company-participation-report`
- Type: Action (Read-only)
- Version: 0.0.2
- App: Bonusly (`bonusly`) — https://pipedream.com/apps/bonusly.md
- This page (HTML): https://pipedream.com/apps/bonusly/actions/get-company-participation-report
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/bonusly/actions/get-company-participation-report/get-company-participation-report.mjs

## Description

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](https://docs.bonus.ly/reference/adminparticipationreport-1)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `reportView` | `string` | Yes | Which participation view to return. |
| `startDate` | `string` | Yes | Start of the report's date range, in YYYY-MM-DD format, e.g. 2026-01-01. |
| `endDate` | `string` | Yes | 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. |
| `customPropertyGroup` | `string` | No | Grouping dimension to break the giving_and_receiving view down by, e.g. department or location. Ignored for the managers_and_teams view. |
| `includeTrend` | `boolean` | No | Set to true to include trend data alongside the current period's metrics. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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": "bonusly",
      },
    },
  },
)

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: "bonusly-get-company-participation-report",
  arguments: {
    reportView: "Report View",
    startDate: "Start Date",
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
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": "bonusly-get-company-participation-report",
    "configured_props": {
      "bonusly": { "authProvisionId": "apn_xxxxxxx" },
      "reportView": "Report View",
      "startDate": "Start Date"
    }
  }'
```

---

- App: https://pipedream.com/apps/bonusly.md · All apps: https://pipedream.com/apps