# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conversions Conversion Events Streaming Workflow API
  version: 1.0.0
extends: openapi/linkedin-conversion-events-streaming-workflow-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/adAccountUsers'].get
  update:
    x-apievangelist-phrasing:
      intent: List ad accounts the user can stream conversions to
      effect: read
      questions:
      - Which sponsored ad accounts can the signed-in user send conversions for?
      - Can I see the user's role on each ad account before setting up conversions?
      instructions:
      - text: List the ad accounts the authenticated user belongs to.
      - text: Retrieve my ad account memberships with fields {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversions'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversion rules in an ad account
      effect: read
      questions:
      - Which conversion rules already exist in my ad account?
      - Can I find the rules set up for Conversions API streaming?
      instructions:
      - text: Fetch conversion rules for ad account {account}.
        slots:
          account: query.account
      - text: List conversion rules in {account} showing {fields}.
        slots:
          account: query.account
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a conversion rule for API streaming
      effect: write
      questions:
      - Can I create a new conversion rule that accepts server-side events?
      - What conversion method should a new rule use to receive streamed conversions?
      instructions:
      - text: Create a new conversion rule set to the Conversions API method.
      - text: Add a conversion rule so I can stream purchases from my server.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccounts/{sponsoredaccount_id}/adCampaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List active campaigns in a sponsored account
      effect: read
      questions:
      - Which campaigns are active in my ad account so I can attach a conversion?
      - Can I search campaigns in a sponsored account by status?
      instructions:
      - text: Fetch active campaigns in sponsored account {sponsoredaccount_id}.
        slots:
          sponsoredaccount_id: path.sponsoredaccount_id
      - text: Search campaigns in {sponsoredaccount_id} matching {search}.
        slots:
          sponsoredaccount_id: path.sponsoredaccount_id
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaignConversions/(campaign:urn:li:sponsoredCampaign:{campaign_id},conversion:urn:lla:llaPartnerConversion:{conversion_id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Associate a campaign with a conversion rule
      effect: write
      questions:
      - How can I make a campaign track a specific conversion rule?
      - Can I link one campaign to a conversion rule I created?
      instructions:
      - text: Associate campaign {campaign_id} with conversion rule {conversion_id}.
        slots:
          campaign_id: path.campaign_id
          conversion_id: path.conversion_id
      - text: Attach conversion {conversion_id} to campaign {campaign_id}.
        slots:
          conversion_id: path.conversion_id
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversionEvents'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream conversion events to a rule
      effect: write
      questions:
      - Can I send several conversion events to a rule in one request?
      - What's the call for streaming offline purchases into a conversion rule?
      instructions:
      - text: Stream a batch of conversion events using restli method {method}.
        slots:
          method: header.X-RestLi-Method
      - text: Send my latest server-side conversions to the conversion rule.
      method: generated
      generated: '2026-09-26'