Eyepup API

openapi: 3.1.0
info:
  title: Eyepup API
  version: '2026-11-07'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-07: 3 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Eyepup has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 3
    pages-with-code: 2
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-07'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://eyepup.com/integrate
  - https://eyepup.com/mcp-analytics
paths:
  /i/conversion:
    post:
      operationId: post_i_conversion
      tags:
      - I
      summary: Typed conversion event. Boosts the visitor's heat score, triggers the first‑conversion email, lights up the dashboard conversion
        charts.
      x-source: https://eyepup.com/integrate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostIConversionRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /i/event:
    post:
      operationId: post_i_event
      tags:
      - I
      summary: Generic server‑side event capture. Anything the browser can't see — backend cron jobs, scheduled tasks, agentic workflows, internal
        admin actions.
      x-source: https://eyepup.com/integrate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostIEventRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /i/identify:
    post:
      operationId: post_i_identify
      tags:
      - I
      summary: Stitches a pre-auth visitor to a post-auth identity.
      x-source: https://eyepup.com/integrate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostIIdentifyRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostIConversionRequest:
      type: object
      properties:
        distinct_id:
          type: string
          description: Visitor identifier (user id, email, or anonymous id).
        name:
          type: string
          description: Name of the conversion event (e.g., "subscribed").
        amount:
          type: number
          description: Revenue amount in the currency's major units.
        currency:
          type: string
          description: Three‑letter ISO currency code (e.g., "USD").
        properties:
          type: object
          description: Additional conversion properties such as plan, interval, source.
      required:
      - distinct_id
      - name
      - amount
      - currency
    PostIEventRequest:
      type: object
      properties:
        distinct_id:
          type: string
          description: Visitor identifier.
        event:
          type: string
          description: Custom event name (e.g., "feature_used").
        properties:
          type: object
          description: Additional event properties.
      required:
      - distinct_id
      - event
    PostIIdentifyRequest:
      type: object
      properties:
        distinct_id:
          type: string
          description: Visitor's pre-auth identifier (from cookie or null).
        user_id:
          type: string
          description: Authenticated user ID.
        email:
          type: string
          description: User email address.
        properties:
          type: object
          description: Additional user properties such as plan and signup_at.
      required:
      - distinct_id
      - user_id
      - email
tags:
- name: I