View as Markdown
Peakon Employee Voice icon

Peakon Employee Voice ACTION

Get Engagement Overview

Returns the engagement score, response rate, NPS breakdown, and favorability data for a company or specific segment context. Pass a contextId formatted as company_[companyId] for company-wide metrics or segment_[segmentId] for a specific segment — use List Segments to discover segment IDs. Use when the user asks 'what is our overall engagement score?', 'how engaged is [segment]?', or 'what is the response rate?'. Returns: engagement score (0–10 scale), NPS score, favorable/neutral/unfavorable split, response count, and last survey date. See the Peakon API documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Peakon Employee Voice account once, then configure and run Get Engagement Overview 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: "peakon_employee_voice-get-engagement-overview",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    peakon_employee_voice: { authProvisionId: "apn_xxxxxxx" },
    contextId: "Context ID",
    interval: "Interval",
  },
})

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 Engagement Overview inputs
Property Type Description
contextId Context ID string
Company or segment context ID. Format: company_[companyId] for company-wide metrics or segment_[segmentId] for a specific segment. Use List Segments to discover available segment IDs.
Required
interval Interval string
Time interval for analytics data. Defaults to quarter.
Optional
observations Include Observations boolean
Whether to include the observations array in the response. Defaults to false.
Optional
participation Include Participation boolean
Whether to include participation data in the response. Defaults to false.
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
peakon_employee_voice-get-engagement-overview
Version
0.0.2
App
Peakon Employee Voice
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes