mammoth-io Mammoth User Events API

openapi: 3.2.0
info:
  title: Mammoth Io Mammoth User Events API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Mammoth User Events across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
  apiSecret: []
  workspaceId: []
tags:
- name: Mammoth User Events
paths:
  /workspaces/{workspace_id}/mm-ue:
    post:
      tags:
      - Mammoth User Events
      summary: Post mammoth user event
      description: Post mammoth user event data
      operationId: Create
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MMUeSchema'
        required: true
      responses:
        '200':
          description: Request processed successfully
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    MMUeSchema:
      properties:
        encoded_data:
          type: string
          title: Encoded Data
          description: "Base64-encoded JSON of Mammoth User Event.\n\nDecoded JSON structure:\n{\n  \"event_origin\": \"string\",\n  \"event_name\": \"string\",\n  \"event_context\": {},\n  \"additional_info\": {},\n  \"browser_name\": \"string\",\n  \"browser_size\": {\"width\": int, \"height\": int},\n  \"browser_version\": \"string\",\n  \"device_info\": \"string\",\n  \"domain\": \"string\",\n  \"email_id\": \"string\",\n  \"os_name\": \"string\",\n  \"timestamp\": float,\n  \"user_name\": \"string\",\n  \"origin\": \"string\",\n  \"session_identifier\": \"string\"\n}"
          examples:
          - value:
              event_origin: web
              event_name: test_event
              event_context: {}
              additional_info: {}
              browser_name: Chrome
              browser_size:
                width: 1440
                height: 900
              browser_version: 120.0.0
              device_info: MacBook Pro (M1)
              domain: app.mammoth.io
              email_id: user@mammoth.io
              os_name: macOS
              timestamp: 1704705600.123
              user_name: john_doe
              origin: web
              session_identifier: 1f8c0b6e-4a3d-4f2b-9c77-2f1a5e8d3b04
        decoded_data:
          type: object
          title: Event Data
          description: Decoded mammoth user event data
          default: {}
      type: object
      required:
      - encoded_data
      title: MMUeSchema
      description: "Base64-encoded JSON of Mammoth User Event.\n\nDecoded JSON structure:\n{\n  \"event_origin\": \"string\",\n  \"event_name\": \"string\",\n  \"event_context\": {},\n  \"additional_info\": {},\n  \"browser_name\": \"string\",\n  \"browser_size\": {\"width\": int, \"height\": int},\n  \"browser_version\": \"string\",\n  \"device_info\": \"string\",\n  \"domain\": \"string\",\n  \"email_id\": \"string\",\n  \"os_name\": \"string\",\n  \"timestamp\": float,\n  \"user_name\": \"string\",\n  \"origin\": \"string\",\n  \"session_identifier\": \"string\"\n}"
      examples:
      - encoded_data: eyJldmVudF9vcmlnaW4iOiAid2ViIiwgImV2ZW50X25hbWUiOiAidGVzdF9ldmVudCIsICJldmVudF9jb250ZXh0Ijoge30sICJhZGRpdGlvbmFsX2luZm8iOiB7fSwgImJyb3dzZXJfbmFtZSI6ICJDaHJvbWUiLCAiYnJvd3Nlcl9zaXplIjogeyJ3aWR0aCI6IDE0NDAsICJoZWlnaHQiOiA5MDB9LCAiYnJvd3Nlcl92ZXJzaW9uIjogIjEyMC4wLjAiLCAiZGV2aWNlX2luZm8iOiAiTWFjQm9vayBQcm8gKE0xKSIsICJkb21haW4iOiAiYXBwLm1hbW1vdGguaW8iLCAiZW1haWxfaWQiOiAidXNlckBtYW1tb3RoLmlvIiwgIm9zX25hbWUiOiAibWFjT1MiLCAidGltZXN0YW1wIjogMTcwNDcwNTYwMC4xMjMsICJ1c2VyX25hbWUiOiAiam9obl9kb2UiLCAib3JpZ2luIjogIndlYiIsICJzZXNzaW9uX2lkZW50aWZpZXIiOiAiMWY4YzBiNmUtNGEzZC00ZjJiLTljNzctMmYxYTVlOGQzYjA0In0=
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
      scheme: bearer
    apiKey:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-KEY
      in: header
    apiSecret:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-SECRET
      in: header
    workspaceId:
      type: apiKey
      description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
      name: X-WORKSPACE-ID
      in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json