openapi: 3.0.2
info:
  title: Insights API
  description: >-
    The Algolia Insights API lets you collect events related to your search and discovery experience.
    Events represent actions that users take on your app or website.
    They unlock powerful features, such as recommendations, personalization, smarter search results,
    and analytics that help you optimize your user experience.
  version: 1.0.0
components:
  securitySchemes:
    appId:
      $ref: '../common/securitySchemes.yml#/appId'
    apiKey:
      $ref: '../common/securitySchemes.yml#/apiKey'
servers:
  - url: https://insights.{region}.algolia.io
    variables:
      region:
        enum:
          - us
          - de
        default: us
  - url: https://insights.algolia.io
security:
  - appId: []
    apiKey: []
tags:
  - name: events
    x-displayName: Events
    description: >-
      Events represent user interactions with your website or app.
      They include details like the event's name, type, a timestamp or a user token.
  - name: usertokens
    x-displayName: User tokens
    description: |
      Delete events related to a specific user token.
x-tagGroups:
  - name: General
    tags:
      - events
      - usertokens
paths:
  # ######################
  # ### Custom request ###
  # ######################
  /1{path}:
    $ref: '../common/paths/customRequest.yml'

  /1/events:
    $ref: 'paths/pushEvents.yml'

  /1/usertokens/{userToken}:
    $ref: 'paths/deleteUserToken.yml'