Act! CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for act.web.api Configurations API

11 actions 11 updates phrasing extends openapi/act-configurations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Act! CRM's API. It is a proposal applied on top of the contract, not a document Act! CRM publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/api/analytics/definitions/insight-views'].get
$.paths['/api/analytics/definitions/insight-views'].put
$.paths['/api/analytics/definitions/insight-views'].delete
$.paths['/api/analytics/definitions/myact-views'].get
$.paths['/api/analytics/definitions/myact-views'].put
$.paths['/api/analytics/definitions/myact-views'].delete
$.paths['/api/analytics/definitions/kpi-views/{name}'].get
$.paths['/api/analytics/definitions/kpi-views/{name}'].put
$.paths['/api/analytics/settings/opportunity-pipeline'].get
$.paths['/api/analytics/settings/opportunity-pipeline'].put

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 act.web.api Configurations API
  version: 1.0.0
extends: openapi/act-configurations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/api/analytics/definitions/insight-views'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my Insights dashboard layout
      effect: read
      questions:
      - What's saved as my Insights analytics view layout?
      - Can I read back my Insights dashboard definition?
      instructions:
      - text: Get my Insights view definition.
      - text: Show the saved layout of my Insights analytics view.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/definitions/insight-views'].put
  update:
    x-apievangelist-phrasing:
      intent: Save my Insights dashboard layout
      effect: write
      questions:
      - Can I save a custom layout for my Insights view?
      - How do I store a new Insights dashboard definition?
      instructions:
      - text: Save {definition} as my Insights view definition.
        slots:
          definition: requestBody.definition
      - text: Store Insights view definition {definition} for user {userId}.
        slots:
          definition: requestBody.definition
          userId: requestBody.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/definitions/insight-views'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset my Insights dashboard layout
      effect: destructive
      questions:
      - Can I clear my saved Insights view and start over?
      - What removes my Insights analytics definition?
      instructions:
      - text: Delete my Insights view definition.
      - text: Clear the saved Insights dashboard layout.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/definitions/myact-views'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my MyAct dashboard layout
      effect: read
      questions:
      - What's saved as my MyAct view layout?
      - Can I read my MyAct dashboard definition?
      instructions:
      - text: Get my MyAct view definition.
      - text: Show the saved layout of my MyAct dashboard.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/definitions/myact-views'].put
  update:
    x-apievangelist-phrasing:
      intent: Save my MyAct dashboard layout
      effect: write
      questions:
      - Can I save a custom arrangement of my MyAct dashboard?
      - Where do I store a new MyAct view definition?
      instructions:
      - text: Save {definition} as my MyAct view definition.
        slots:
          definition: requestBody.definition
      - text: Store MyAct view definition {definition} for user {userId}.
        slots:
          definition: requestBody.definition
          userId: requestBody.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/definitions/myact-views'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset my MyAct dashboard layout
      effect: destructive
      questions:
      - Can I wipe my MyAct dashboard back to defaults?
      - What deletes my saved MyAct view?
      instructions:
      - text: Delete my MyAct view definition.
      - text: Clear the saved MyAct dashboard layout.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/definitions/kpi-views/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a saved KPI view
      effect: read
      questions:
      - What's in one of my named KPI view containers?
      - Can I read the definition of a KPI view by name?
      instructions:
      - text: Get my KPI view {name}.
        slots:
          name: path.name
      - text: Show the saved definition of KPI container {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/definitions/kpi-views/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Save a KPI view
      effect: write
      questions:
      - Can I create or update a named KPI view?
      - How do I store a KPI dashboard definition under a name?
      instructions:
      - text: Save {definition} as KPI view {name}.
        slots:
          definition: requestBody.definition
          name: path.name
      - text: Update KPI container {name} with definition {definition}.
        slots:
          name: path.name
          definition: requestBody.definition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/settings/opportunity-pipeline'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my pipeline view settings
      effect: read
      questions:
      - What settings are saved for my opportunity pipeline view?
      - Can I read back my pipeline chart preferences?
      instructions:
      - text: Get my opportunity pipeline view settings.
      - text: Show how my pipeline analytics view is configured.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/settings/opportunity-pipeline'].put
  update:
    x-apievangelist-phrasing:
      intent: Save my pipeline view settings
      effect: write
      questions:
      - Can I change and save my opportunity pipeline view settings?
      - How do I store new preferences for the pipeline chart?
      instructions:
      - text: Save pipeline view settings {settingsDefinition}.
        slots:
          settingsDefinition: requestBody.settingsDefinition
      - text: Update the opportunity pipeline settings for user {userId} to {settingsDefinition}.
        slots:
          userId: requestBody.userId
          settingsDefinition: requestBody.settingsDefinition
      method: generated
      generated: '2026-10-01'