> ## Documentation Index
> Fetch the complete documentation index at: https://docs.outlit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview the activation event

> Historically evaluate exact ordinary product-event matches without saving configuration, materializing activation, or mutating customer state.



## OpenAPI

````yaml /openapi.json post /api/activation/preview
openapi: 3.1.0
info:
  title: Outlit API
  summary: Public Outlit Platform and Ingest APIs.
  description: >-
    Canonical OpenAPI specification for the public Outlit API surfaces
    documented at docs.outlit.ai.
  version: 1.0.0
servers:
  - url: https://app.outlit.ai
security:
  - bearerAuth: []
tags:
  - name: Platform API
    description: >-
      Authenticated API key routes for customer intelligence tools and
      integration management.
  - name: Ingest API
    description: Public-key event ingestion routes used by Outlit SDKs.
paths:
  /api/activation/preview:
    post:
      tags:
        - Platform API
      summary: Preview the activation event
      description: >-
        Historically evaluate exact ordinary product-event matches without
        saving configuration, materializing activation, or mutating customer
        state.
      operationId: previewCustomerActivation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerActivationPreviewRequest'
            example:
              eventName: integration_connected
              lookbackDays: 60
              exampleLimit: 10
      responses:
        '200':
          description: The read-only historical preview completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewCustomerActivationCommandSuccess'
        '400':
          description: The request body failed company activation preview validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommandErrorEnvelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The API key is valid but does not have company activation read
            authorization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommandErrorEnvelope'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          description: The platform could not preview company activation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommandErrorEnvelope'
components:
  schemas:
    CustomerActivationPreviewRequest:
      type: object
      required:
        - eventName
      properties:
        eventName:
          type: string
          minLength: 1
          maxLength: 191
        lookbackDays:
          type: integer
          minimum: 1
          maximum: 90
          default: 30
        exampleLimit:
          type: integer
          minimum: 1
          maximum: 20
          default: 10
      additionalProperties: false
    PreviewCustomerActivationCommandSuccess:
      type: object
      required:
        - ok
        - commandId
        - commandVersion
        - correlationId
        - result
      properties:
        ok:
          type: boolean
          const: true
        commandId:
          type: string
          const: customer_activation.preview
        commandVersion:
          type: integer
          const: 1
        correlationId:
          type: string
        result:
          allOf:
            - $ref: '#/components/schemas/CommandResultBase'
            - type: object
              properties:
                operationId:
                  type: string
                  const: customer_activation.preview
                data:
                  $ref: '#/components/schemas/CustomerActivationPreviewData'
      additionalProperties: false
    CommandErrorEnvelope:
      type: object
      required:
        - ok
        - commandId
        - commandVersion
        - error
      properties:
        ok:
          type: boolean
          const: false
        commandId:
          type: string
        commandVersion:
          type: integer
          minimum: 1
        error:
          type: object
          required:
            - code
            - message
            - correlationId
            - retryable
          properties:
            code:
              type: string
              enum:
                - validation_failed
                - authorization_denied
                - conflict
                - not_found
                - rate_limited
                - transient_failure
            message:
              type: string
            correlationId:
              type: string
            retryable:
              type: boolean
            details:
              type: object
              additionalProperties: true
          additionalProperties: false
      additionalProperties: false
    CommandResultBase:
      type: object
      required:
        - operationId
        - status
        - resources
        - data
        - warnings
      properties:
        operationId:
          type: string
        status:
          type: string
          const: completed
        resources:
          type: array
          items:
            $ref: '#/components/schemas/CommandResource'
        data:
          type: object
          additionalProperties: true
        warnings:
          type: array
          items:
            type: string
        auditId:
          type: string
      additionalProperties: false
    CustomerActivationPreviewData:
      type: object
      required:
        - preview
      properties:
        preview:
          $ref: '#/components/schemas/CustomerActivationPreviewResult'
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
      additionalProperties: true
    CommandResource:
      type: object
      required:
        - type
        - id
      properties:
        type:
          type: string
        id:
          type: string
      additionalProperties: false
    CustomerActivationPreviewResult:
      type: object
      required:
        - eventName
        - evaluatedFrom
        - evaluatedTo
        - evaluatedEventCount
        - matchedCustomerCount
        - alreadyActivatedCustomerCount
        - wouldActivateCustomerCount
        - evaluatedContactOccurrenceCount
        - matchedContactCount
        - alreadyActivatedContactCount
        - wouldActivateContactCount
        - contactTruncated
        - customerTruncated
        - truncated
        - examples
      properties:
        eventName:
          type: string
          minLength: 1
          maxLength: 191
        evaluatedFrom:
          type: string
          format: date-time
        evaluatedTo:
          type: string
          format: date-time
        evaluatedEventCount:
          type: integer
          minimum: 0
        matchedCustomerCount:
          type: integer
          minimum: 0
        alreadyActivatedCustomerCount:
          type: integer
          minimum: 0
        wouldActivateCustomerCount:
          type: integer
          minimum: 0
        evaluatedContactOccurrenceCount:
          type: integer
          minimum: 0
        matchedContactCount:
          type: integer
          minimum: 0
        alreadyActivatedContactCount:
          type: integer
          minimum: 0
        wouldActivateContactCount:
          type: integer
          minimum: 0
        contactTruncated:
          type: boolean
        customerTruncated:
          type: boolean
        truncated:
          type: boolean
        examples:
          type: array
          items:
            $ref: '#/components/schemas/CustomerActivationPreviewExample'
      additionalProperties: false
    ValidationIssue:
      type: object
      required:
        - path
        - message
      properties:
        path:
          type: array
          items:
            type:
              - string
              - number
        message:
          type: string
      additionalProperties: false
    CustomerActivationPreviewExample:
      type: object
      required:
        - customer
        - activatedAt
        - firstMatchedAt
        - eventId
      properties:
        customer:
          $ref: '#/components/schemas/CustomerActivationPreviewCustomer'
        activatedAt:
          type:
            - string
            - 'null'
          format: date-time
        firstMatchedAt:
          type: string
          format: date-time
        eventId:
          type: string
          format: uuid
      additionalProperties: false
    CustomerActivationPreviewCustomer:
      type: object
      required:
        - id
        - name
        - domain
      properties:
        id:
          type: string
          minLength: 1
        name:
          type: string
          minLength: 1
        domain:
          type: string
          minLength: 1
      additionalProperties: false
  responses:
    Unauthorized:
      description: Invalid or missing API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Invalid credentials
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Internal server error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Outlit API key using the Bearer ok_... format.

````