# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Insights API
  version: 1.0.0
extends: openapi/algolia-insights-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: 7
- target: $.paths['/{path}'].get
  update:
    x-apievangelist-phrasing:
      intent: Send a custom GET request to the Insights API
      effect: read
      questions:
      - Can I call an Insights API endpoint the client library doesn't wrap yet with a raw GET?
      - Is there a generic way to read from an arbitrary Insights API path?
      instructions:
      - text: Send a raw GET request to the Insights API path {path}.
        slots:
          path: path.path
      - text: Call GET on Insights endpoint {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{path}'].put
  update:
    x-apievangelist-phrasing:
      intent: Send a custom PUT request to the Insights API
      effect: write
      questions:
      - How can I send a PUT to an Insights API path that has no dedicated method?
      - Can I replace something at a custom Insights endpoint using a raw PUT call?
      instructions:
      - text: Send a raw PUT request to the Insights API path {path}.
        slots:
          path: path.path
      - text: Issue a PUT to Insights endpoint {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{path}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a custom POST request to the Insights API
      effect: write
      questions:
      - What's the way to POST to a new Insights API endpoint before the SDK supports it?
      - Can I make a raw POST call to any Insights path?
      instructions:
      - text: Send a raw POST request to the Insights API path {path}.
        slots:
          path: path.path
      - text: POST to Insights endpoint {path} passing query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{path}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Send a custom DELETE request to the Insights API
      effect: destructive
      questions:
      - How do I send a raw DELETE to an Insights API path the client doesn't cover?
      - Can I call DELETE on an arbitrary Insights endpoint?
      instructions:
      - text: Send a raw DELETE request to the Insights API path {path}.
        slots:
          path: path.path
      - text: Issue a DELETE against Insights endpoint {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Send click, conversion and view events
      effect: write
      questions:
      - How do I send click and conversion events from my search UI to Algolia?
      - How many events can I include in one request, and is there a size limit?
      - Can I batch up user view events and push them all at once?
      instructions:
      - text: 'Send these user events to Insights: {events}.'
        slots:
          events: requestBody.events
      - text: Push the batch of click and purchase events {events} for analytics and personalization.
        slots:
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/usertokens/{userToken}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all events for a user token
      effect: destructive
      questions:
      - How can I erase every event recorded for one user, for example for a privacy request?
      - How long does it take for a user token's events to be removed from analytics?
      instructions:
      - text: Delete all events tied to user token {userToken}.
        slots:
          userToken: path.userToken
      - text: Purge the event history of user {userToken} from Insights metrics and analytics.
        slots:
          userToken: path.userToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/setClientApiKey'].get
  update:
    x-apievangelist-phrasing:
      intent: Switch the API key the Insights client uses
      effect: write
      questions:
      - Can I change which API key my Insights client authenticates with without recreating it?
      - Is it possible to rotate the key used for sending events at runtime?
      instructions:
      - text: Switch the Insights client to authenticate with API key {apiKey}.
        slots:
          apiKey: query.apiKey
      - text: Use {apiKey} as the key for subsequent Insights requests.
        slots:
          apiKey: query.apiKey
      method: generated
      generated: '2026-09-26'