Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Embedded Reports API

17 actions 17 updates phrasing extends openapi/deputy-embedded-reports-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 17 · first 16 shown; the file carries all of them

$.info
$.paths['/management/v2/reports/embed'].get
$.paths['/management/v2/reports/embed/classic'].get
$.paths['/management/v2/reports/embed/copy-workbook'].post
$.paths['/management/v2/reports/embed/create-workbook'].post
$.paths['/management/v2/reports/embed/downgrade-sigma-member-license:bulk'].post
$.paths['/management/v2/reports/embed/generate-url'].post
$.paths['/management/v2/reports/embed/get-users-by-permission'].post
$.paths['/management/v2/reports/embed/home-folder-workbooks'].get
$.paths['/management/v2/reports/embed/rename-workbook'].post
$.paths['/management/v2/reports/embed/share-workbook'].post
$.paths['/management/v2/reports/embed/tenant-onboarding'].post
$.paths['/management/v2/reports/embed/update-tenant'].post
$.paths['/management/v2/reports/embed/workbook/shared-with-me'].get
$.paths['/management/v2/reports/embed/workbook/{id}'].delete
$.paths['/management/v2/reports/embed/workbook/{id}/shared-with'].get

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 Embedded Reports API
  version: 1.0.0
extends: openapi/deputy-embedded-reports-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: 16
- target: $.paths['/management/v2/reports/embed'].get
  update:
    x-apievangelist-phrasing:
      intent: List embedded Sigma reports
      effect: read
      questions:
      - Which embedded Sigma reports can I embed in my app?
      - Can I filter the list of embedded reports?
      instructions:
      - text: List embedded reports matching {filters}.
        slots:
          filters: query.filters
      - text: Show {limit} embedded reports.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/classic'].get
  update:
    x-apievangelist-phrasing:
      intent: List classic embedded reports
      effect: read
      questions:
      - Can I still access the classic embedded reports?
      - What filters work on the classic report list?
      instructions:
      - text: List classic embedded reports matching {filters}.
        slots:
          filters: query.filters
      - text: Show {limit} classic reports.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/copy-workbook'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy an embedded workbook
      effect: write
      questions:
      - How do I duplicate an existing embedded workbook?
      - Can I copy a workbook into my own Sigma workspace?
      instructions:
      - text: Copy workbook {data}.
        slots:
          data: requestBody.data
      - text: Duplicate the embedded workbook described by {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/create-workbook'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new embedded workbook
      effect: write
      questions:
      - Can I create a brand-new embedded workbook?
      - What does a new embedded workbook start with?
      instructions:
      - text: Create a new embedded workbook with {data}.
        slots:
          data: requestBody.data
      - text: Start a fresh embedded workbook from {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/downgrade-sigma-member-license:bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Downgrade all Sigma licenses for a tenant
      effect: destructive
      questions:
      - Can I downgrade every Sigma team member license at once?
      - Is there a bulk downgrade for a tenant's Sigma licenses?
      instructions:
      - text: Downgrade all Sigma licenses for this tenant.
      - text: Bulk downgrade every team member license on the Sigma workspace.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/generate-url'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate an embed URL for a workbook
      effect: write
      questions:
      - How do I get an embed URL for an embedded workbook?
      - Can I generate a shareable link for a workbook?
      instructions:
      - text: Generate an embed URL for workbook {data}.
        slots:
          data: requestBody.data
      - text: Create a shareable link for the embedded workbook {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/get-users-by-permission'].post
  update:
    x-apievangelist-phrasing:
      intent: Find users with a permission
      effect: read
      questions:
      - Who has a given permission in embedded reports?
      - Can I list users who hold a specific embedded report permission?
      instructions:
      - text: Find users who have permission {data}.
        slots:
          data: requestBody.data
      - text: List embedded report users with the {data} permission.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/home-folder-workbooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List workbooks in the embed user's home folder
      effect: read
      questions:
      - Which workbooks live in my embed user home folder?
      - Can I filter the home folder workbook list?
      instructions:
      - text: List home folder workbooks matching {filters}.
        slots:
          filters: query.filters
      - text: Show {limit} workbooks in my embed home folder.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/rename-workbook'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename an embedded workbook
      effect: write
      questions:
      - How do I rename a workbook in my embed home folder?
      - Can I change the name of an embedded workbook?
      instructions:
      - text: Rename home folder workbook {data}.
        slots:
          data: requestBody.data
      - text: Change the name of my embedded workbook to {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/share-workbook'].post
  update:
    x-apievangelist-phrasing:
      intent: Share an embedded workbook
      effect: write
      questions:
      - How do I share an embedded workbook with a team?
      - Can I update the grants on an embedded workbook?
      instructions:
      - text: Share workbook {data}.
        slots:
          data: requestBody.data
      - text: Update the grants on my embedded workbook {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/tenant-onboarding'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a Sigma workspace for a tenant
      effect: write
      questions:
      - How do I set up a Sigma workspace and team for my tenant?
      - Can I provision Sigma for a new tenant by hostname?
      instructions:
      - text: Provision a Sigma workspace for tenant {hostname}.
        slots:
          hostname: requestBody.hostname
      - text: Create a Sigma team for {hostname} described as {description}.
        slots:
          hostname: requestBody.hostname
          description: requestBody.description
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/update-tenant'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a tenant's data on Sigma
      effect: write
      questions:
      - Can I update the tenant data already on Sigma?
      - What fields can I change on a Sigma tenant record?
      instructions:
      - text: Update Sigma tenant data with {data}.
        slots:
          data: requestBody.data
      - text: Change the existing Sigma tenant record to {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/workbook/shared-with-me'].get
  update:
    x-apievangelist-phrasing:
      intent: List workbooks shared with me
      effect: read
      questions:
      - Which workbooks have been shared with me?
      - Can I filter the workbooks shared with me?
      instructions:
      - text: List workbooks shared with me matching {filters}.
        slots:
          filters: query.filters
      - text: Show {limit} workbooks shared with me.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/workbook/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an embedded workbook
      effect: destructive
      questions:
      - How do I delete an embedded workbook?
      - Can I remove a workbook from my Sigma workspace?
      instructions:
      - text: Delete workbook {id}.
        slots:
          id: path.id
      - text: Remove embedded workbook {id} from my workspace.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/workbook/{id}/shared-with'].get
  update:
    x-apievangelist-phrasing:
      intent: Check who a workbook is shared with
      effect: read
      questions:
      - Who has access to a given embedded workbook?
      - Can I see the shared status of a workbook?
      instructions:
      - text: Show who workbook {id} is shared with.
        slots:
          id: path.id
      - text: List the shared-with status of embedded workbook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/reports/embed/workbook/{id}:remove-shared-access'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke shared access to a workbook
      effect: destructive
      questions:
      - How do I stop sharing an embedded workbook?
      - Can I revoke a user's access to a workbook?
      instructions:
      - text: Remove shared access to workbook {id}.
        slots:
          id: path.id
      - text: Revoke the access grant {data} on workbook {id}.
        slots:
          data: requestBody.data
          id: path.id
      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-embedded-reports-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.