Unify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Unify Analytics Events API

4 actions 4 updates phrasing extends openapi/unify-events-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Unify's API. It is a proposal applied on top of the contract, not a document Unify publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/identify'].post
$.paths['/page'].post
$.paths['/track'].post

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 Unify Analytics Events API
  version: 1.0.0
extends: openapi/unify-events-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: 3
- target: $.paths['/identify'].post
  update:
    x-apievangelist-phrasing:
      intent: Identify a website visitor
      effect: write
      questions:
      - How do I tell Unify who an anonymous website visitor actually is?
      - Can I attach company and person details when identifying a visitor?
      - What traits can I send along with an identify call?
      instructions:
      - text: Send an identify event for visitor {visitorId} with traits {traits} at {timestamp}.
        slots:
          visitorId: requestBody.visitorId
          traits: requestBody.traits
          timestamp: requestBody.timestamp
      - text: Identify visitor {visitorId} as person {person} at company {company}.
        slots:
          visitorId: requestBody.visitorId
          person: requestBody.person
          company: requestBody.company
      method: generated
      generated: '2026-10-01'
- target: $.paths['/page'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a page view
      effect: write
      questions:
      - How do I log that a visitor viewed a page on my site?
      - Can I include the page name and details with a page view event?
      instructions:
      - text: Record a page view of {name} by visitor {visitorId} at {timestamp}.
        slots:
          name: requestBody.name
          visitorId: requestBody.visitorId
          timestamp: requestBody.timestamp
      - text: Send a page event for visitor {visitorId} in session {sessionId} with page details {properties}.
        slots:
          visitorId: requestBody.visitorId
          sessionId: requestBody.sessionId
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/track'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a custom product event
      effect: write
      questions:
      - How do I record a custom action like a signup or a button click?
      - Can a tracked event carry extra properties about what the visitor did?
      instructions:
      - text: Track event {name} for visitor {visitorId} at {timestamp}.
        slots:
          name: requestBody.name
          visitorId: requestBody.visitorId
          timestamp: requestBody.timestamp
      - text: Send a track event {name} with properties {properties} for visitor {visitorId}.
        slots:
          name: requestBody.name
          properties: requestBody.properties
          visitorId: requestBody.visitorId
      method: generated
      generated: '2026-10-01'