# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Edge Impulse Organization Data Campaigns API
  version: 1.0.0
extends: openapi/edge-impulse-organizationdatacampaigns-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: 12
- target: $.paths['/api/organizations/{organizationId}/campaign-dashboards'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's data campaign dashboards
      effect: read
      questions:
      - What data campaign dashboards does my organization have?
      - Where can I see all the dashboards tracking our data collection campaigns?
      instructions:
      - text: List the data campaign dashboards for organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show every campaign dashboard in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/campaign-dashboards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data campaign dashboard
      effect: write
      questions:
      - How do I set up a dashboard that emails progress on our data collection campaigns?
      - Can I choose who gets the dashboard email and how many days of history it shows?
      instructions:
      - text: Create a campaign dashboard {name} in organization {organizationId} emailing {emailRecipientUids} {whenToEmail}, showing {showNoOfDays} days.
        slots:
          name: requestBody.name
          organizationId: path.organizationId
          emailRecipientUids: requestBody.emailRecipientUids
          whenToEmail: requestBody.whenToEmail
          showNoOfDays: requestBody.showNoOfDays
      - text: Add a new data campaign dashboard named {name} to organization {organizationId}.
        slots:
          name: requestBody.name
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data campaign dashboard
      effect: read
      questions:
      - How is a particular campaign dashboard configured, and who receives its emails?
      - Can I look up one data campaign dashboard by its ID?
      instructions:
      - text: Get campaign dashboard {campaignDashboardId} in organization {organizationId}.
        slots:
          campaignDashboardId: path.campaignDashboardId
          organizationId: path.organizationId
      - text: Show the settings of data campaign dashboard {campaignDashboardId}.
        slots:
          campaignDashboardId: path.campaignDashboardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a data campaign dashboard
      effect: write
      questions:
      - How do I change who gets the email from an existing campaign dashboard?
      - Can I change how often a campaign dashboard sends its summary email?
      instructions:
      - text: Rename campaign dashboard {campaignDashboardId} in organization {organizationId} to {name}.
        slots:
          campaignDashboardId: path.campaignDashboardId
          organizationId: path.organizationId
          name: requestBody.name
      - text: Change dashboard {campaignDashboardId} to email {emailRecipientUids} {whenToEmail}.
        slots:
          campaignDashboardId: path.campaignDashboardId
          emailRecipientUids: requestBody.emailRecipientUids
          whenToEmail: requestBody.whenToEmail
      - text: Make existing dashboard {campaignDashboardId} show the last {showNoOfDays} days.
        slots:
          campaignDashboardId: path.campaignDashboardId
          showNoOfDays: requestBody.showNoOfDays
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data campaign dashboard
      effect: destructive
      questions:
      - How do I get rid of a campaign dashboard we no longer use?
      - Can I remove a data campaign dashboard from my organization?
      instructions:
      - text: Delete campaign dashboard {campaignDashboardId} from organization {organizationId}.
        slots:
          campaignDashboardId: path.campaignDashboardId
          organizationId: path.organizationId
      - text: Remove data campaign dashboard {campaignDashboardId}.
        slots:
          campaignDashboardId: path.campaignDashboardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List the campaigns on a dashboard
      effect: read
      questions:
      - Which data campaigns are shown on a given dashboard?
      - What campaigns roll up into one campaign dashboard?
      instructions:
      - text: List the data campaigns on dashboard {campaignDashboardId} in organization {organizationId}.
        slots:
          campaignDashboardId: path.campaignDashboardId
          organizationId: path.organizationId
      - text: Show every campaign tracked by dashboard {campaignDashboardId}.
        slots:
          campaignDashboardId: path.campaignDashboardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}/screenshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a screenshot of a campaign dashboard
      effect: write
      questions:
      - Is there an internal way to store a screenshot image of a campaign dashboard?
      - Which call attaches a picture of a dashboard to its record?
      instructions:
      - text: Upload screenshot {image} for campaign dashboard {campaignDashboardId} in organization {organizationId}.
        slots:
          image: requestBody.image
          campaignDashboardId: path.campaignDashboardId
          organizationId: path.organizationId
      - text: Attach image {image} as the screenshot of dashboard {campaignDashboardId}.
        slots:
          image: requestBody.image
          campaignDashboardId: path.campaignDashboardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/campaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a data campaign to a dashboard
      effect: write
      questions:
      - How do I start tracking a new data collection campaign on a dashboard?
      - What does a new data campaign need — coordinators, queries, datasets, pipelines and projects?
      instructions:
      - text: Add campaign {name} to dashboard {dataCampaignDashboardId} in organization {organizationId}, described as {description}.
        slots:
          name: requestBody.name
          dataCampaignDashboardId: requestBody.dataCampaignDashboardId
          organizationId: path.organizationId
          description: requestBody.description
      - text: Create data campaign {name} coordinated by {coordinatorUids}, covering datasets {datasets} and projects {projectIds}.
        slots:
          name: requestBody.name
          coordinatorUids: requestBody.coordinatorUids
          datasets: requestBody.datasets
          projectIds: requestBody.projectIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/campaigns/{campaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data campaign
      effect: read
      questions:
      - Who coordinates a given data campaign and which datasets does it cover?
      - Can I look up one data campaign's details by ID?
      instructions:
      - text: Get data campaign {campaignId} in organization {organizationId}.
        slots:
          campaignId: path.campaignId
          organizationId: path.organizationId
      - text: Show the details of campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/campaigns/{campaignId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a data campaign
      effect: write
      questions:
      - How do I add another coordinator to an existing data campaign?
      - Can I move a campaign to a different dashboard or change its linked projects?
      instructions:
      - text: Rename data campaign {campaignId} in organization {organizationId} to {name}.
        slots:
          campaignId: path.campaignId
          organizationId: path.organizationId
          name: requestBody.name
      - text: Set the coordinators of existing campaign {campaignId} to {coordinatorUids}.
        slots:
          campaignId: path.campaignId
          coordinatorUids: requestBody.coordinatorUids
      - text: Move campaign {campaignId} onto dashboard {dataCampaignDashboardId}.
        slots:
          campaignId: path.campaignId
          dataCampaignDashboardId: requestBody.dataCampaignDashboardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/campaigns/{campaignId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data campaign
      effect: destructive
      questions:
      - How do I remove a finished data campaign from its dashboard?
      - Can I delete a single data campaign without deleting the dashboard?
      instructions:
      - text: Delete data campaign {campaignId} from organization {organizationId}.
        slots:
          campaignId: path.campaignId
          organizationId: path.organizationId
      - text: Remove campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/organizations/{organizationId}/campaigns/{campaignId}/diff'].post
  update:
    x-apievangelist-phrasing:
      intent: See which campaign data items changed in the past day
      effect: read
      questions:
      - Which data items in a campaign changed over the last day?
      - Can I check a campaign's queries for new or modified data since yesterday?
      instructions:
      - text: Show what changed in the past day for campaign {campaignId} in organization {organizationId} using queries {queries}.
        slots:
          campaignId: path.campaignId
          organizationId: path.organizationId
          queries: requestBody.queries
      - text: Diff campaign {campaignId} for queries {queries} to find data items that differ since yesterday.
        slots:
          campaignId: path.campaignId
          queries: requestBody.queries
      method: generated
      generated: '2026-10-01'