Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Employee Sentiment API

8 actions 8 updates phrasing extends openapi/deputy-employee-sentiment-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Deputy's API. It is a proposal applied on top of the contract, not a document Deputy publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/v2/employee-sentiment'].post
$.paths['/v2/employee-sentiment/settings'].get
$.paths['/v2/employee-sentiment/start/{start}/end/{end}'].get
$.paths['/v2/employee-sentiment/start/{start}/end/{end}/location-id/{locationId}'].get
$.paths['/v2/employee-sentiment/start/{start}/end/{end}/location-id/{locationId}/weekly'].get
$.paths['/v2/employee-sentiment/start/{start}/end/{end}/weekly'].get
$.paths['/v2/employee-sentiment:check'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Deputy V2 Employee Sentiment API
  version: 1.0.0
extends: openapi/deputy-employee-sentiment-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-17'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/v2/employee-sentiment'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an employee pulse sentiment
      effect: write
      questions:
      - How do I record an employee's sentiment pulse?
      - Can I log a sentiment for a single employee?
      instructions:
      - text: Record an employee sentiment.
      - text: Log a pulse sentiment for this employee.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v2/employee-sentiment/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get pulse settings
      effect: read
      questions:
      - What pulse settings are configured?
      - Can I check the pulse settings?
      instructions:
      - text: Get the pulse settings.
      - text: Show the current pulse configuration.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v2/employee-sentiment/start/{start}/end/{end}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get aggregated employee sentiment
      effect: read
      questions:
      - What is the overall employee sentiment across all locations?
      - Can I get aggregated sentiment for a date range?
      instructions:
      - text: Get aggregated employee sentiment from {start} to {end}.
        slots:
          start: path.start
          end: path.end
      - text: Show overall sentiment across all locations between {start} and {end}.
        slots:
          start: path.start
          end: path.end
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v2/employee-sentiment/start/{start}/end/{end}/location-id/{locationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get aggregated sentiment by location
      effect: read
      questions:
      - How is sentiment trending at one location?
      - Can I see sentiment for a single location?
      instructions:
      - text: Get aggregated sentiment for location {locationId} from {start} to {end}.
        slots:
          locationId: path.locationId
          start: path.start
          end: path.end
      - text: Show sentiment at location {locationId} between {start} and {end}.
        slots:
          locationId: path.locationId
          start: path.start
          end: path.end
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v2/employee-sentiment/start/{start}/end/{end}/location-id/{locationId}/weekly'].get
  update:
    x-apievangelist-phrasing:
      intent: Get weekly aggregated employee sentiment by location
      effect: read
      questions:
      - What is the average employee sentiment at a location over a week?
      - Can I get weekly aggregated sentiment for one service location?
      instructions:
      - text: Get weekly aggregated employee sentiment for location {locationId} from {start} to {end}.
        slots:
          locationId: path.locationId
          start: path.start
          end: path.end
      - text: Summarize weekly sentiment at {locationId} between {start} and {end}.
        slots:
          locationId: path.locationId
          start: path.start
          end: path.end
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v2/employee-sentiment/start/{start}/end/{end}/weekly'].get
  update:
    x-apievangelist-phrasing:
      intent: Get weekly aggregated sentiment
      effect: read
      questions:
      - What is the weekly sentiment trend overall?
      - Can I see sentiment broken down by week for all locations?
      instructions:
      - text: Get weekly aggregated sentiment from {start} to {end}.
        slots:
          start: path.start
          end: path.end
      - text: Show weekly sentiment overall between {start} and {end}.
        slots:
          start: path.start
          end: path.end
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v2/employee-sentiment:check'].post
  update:
    x-apievangelist-phrasing:
      intent: Check sentiment eligibility
      effect: read
      questions:
      - Can an employee take a sentiment pulse?
      - How do I check sentiment eligibility?
      instructions:
      - text: Check sentiment eligibility.
      - text: Tell me if an employee is eligible for a sentiment pulse.
      method: generated
      generated: '2026-11-17'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-employee-sentiment-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.