Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Web Analytics API

6 actions 6 updates phrasing extends openapi/strivacity-web-analytics-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Strivacity's API. It is a proposal applied on top of the contract, not a document Strivacity publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/admin/api/v1/instance/webAnalytics'].get

$.paths['/admin/api/v1/instance/webAnalytics'].post

$.paths['/admin/api/v1/instance/webAnalytics/{id}'].get

$.paths['/admin/api/v1/instance/webAnalytics/{id}'].put

$.paths['/admin/api/v1/instance/webAnalytics/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin Portal Web Analytics API
  version: 1.0.0
extends: openapi/strivacity-web-analytics-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: 5
- target: $.paths['/admin/api/v1/instance/webAnalytics'].get
  update:
    x-apievangelist-phrasing:
      intent: List web analytics integrations
      effect: read
      questions:
      - Which web analytics integrations are connected to my instance?
      - Can I page through the configured analytics integrations?
      instructions:
      - text: List web analytics integrations.
      - text: Show web analytics integrations, page {page}.
        slots:
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/webAnalytics'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a web analytics integration
      effect: write
      questions:
      - How do I connect a web analytics tool to track login pages?
      - What API key and configuration does a web analytics integration need?
      instructions:
      - text: Create web analytics integration {id} with API key {apiKey}.
        slots:
          id: requestBody.id
          apiKey: requestBody.apiKey
      - text: Add analytics integration {id} using configuration {configuration} and key {apiKey}.
        slots:
          id: requestBody.id
          configuration: requestBody.configuration
          apiKey: requestBody.apiKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/webAnalytics/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a web analytics integration
      effect: read
      questions:
      - Can I view the settings of one web analytics integration?
      - Is a specific analytics integration enabled?
      instructions:
      - text: Get web analytics integration {id}.
        slots:
          id: path.id
      - text: Show the configuration of analytics integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/webAnalytics/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a web analytics integration
      effect: write
      questions:
      - How do I rotate the API key of a web analytics integration?
      - Can I turn off an analytics integration without deleting it?
      instructions:
      - text: Update analytics integration {id} with API key {apiKey}.
        slots:
          id: path.id
          apiKey: requestBody.apiKey
      - text: Set enabled to {enabled} on web analytics integration {id}.
        slots:
          enabled: requestBody.enabled
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/webAnalytics/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a web analytics integration
      effect: destructive
      questions:
      - How do I disconnect a web analytics integration completely?
      - Is removing an analytics integration permanent?
      instructions:
      - text: Delete web analytics integration {id}.
        slots:
          id: path.id
      - text: Remove analytics integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'