OpenObserve Rum API

openapi: 3.1.0
info:
  title: openobserve Actions Rum API
  description: OpenObserve API documents [https://openobserve.ai/docs/](https://openobserve.ai/docs/)
  contact:
    name: OpenObserve
    url: https://openobserve.ai/
    email: hello@zinclabs.io
  license:
    name: AGPL-3.0
    identifier: AGPL-3.0
  version: 0.90.0
tags:
- name: Rum
paths:
  /rum/v1/{org_id}/logs:
    post:
      tags:
      - Rum
      summary: Ingest RUM log events
      description: Ingests Real User Monitoring (RUM) log events and client-side application logs in JSON array format. Captures browser console logs, application errors, debug information, and custom log messages generated by client-side JavaScript. Logs are enriched with browser and session context for comprehensive client-side debugging and monitoring.
      operationId: LogIngestionJson
      parameters:
      - name: org_id
        in: path
        description: Organization name
        required: true
        schema:
          type: string
      requestBody:
        description: Ingest data (json array)
        content:
          application/json:
            schema:
              type: string
            example:
            - Year: 1896
              City: Athens
              Sport: Aquatics
              Discipline: Swimming
              Athlete: Alfred
              Country: HUN
            - Year: 1896
              City: Athens
              Sport: Aquatics
              Discipline: Swimming
              Athlete: HERSCHMANN
              Country: CHN
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              example:
                code: 200
                status:
                - name: olympics
                  successful: 3
                  failed: 0
        '500':
          description: Failure
          content:
            application/json:
              schema:
                default: null
      security:
      - Authorization: []
      x-o2-mcp:
        enabled: false
  /rum/v1/{org_id}/replay:
    post:
      tags:
      - Rum
      summary: Ingest session replay data
      description: Ingests Real User Monitoring (RUM) session replay data as compressed multipart form data. Captures user interactions, DOM snapshots, and browser events to enable complete session replay functionality. Data is compressed using zlib compression and includes session metadata such as timing, view information, and interaction sequences for comprehensive user experience analysis.
      operationId: ReplayIngestionJson
      parameters:
      - name: org_id
        in: path
        description: Organization name
        required: true
        schema:
          type: string
      requestBody:
        description: Multipart form data containing compressed session replay segment and event metadata
        content:
          multipart/form-data:
            schema:
              type: object
              description: Multipart form data being ingested in the form of session-replay
              required:
              - segment
              - event
              properties:
                event:
                  type: string
                  format: binary
                segment:
                  type: string
                  format: binary
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              example:
                code: 200
                status:
                - name: olympics
                  successful: 3
                  failed: 0
        '500':
          description: Failure
          content:
            application/json:
              schema:
                default: null
      security:
      - Authorization: []
      x-o2-mcp:
        enabled: false
  /rum/v1/{org_id}/rum:
    post:
      tags:
      - Rum
      summary: Ingest RUM data events
      description: Ingests Real User Monitoring (RUM) data events in JSON format. Collects client-side performance metrics, user interactions, application errors, and user experience data for comprehensive web application monitoring. Data is automatically enriched with metadata and stored for analysis and dashboard visualization.
      operationId: RumIngestionMulti
      parameters:
      - name: org_id
        in: path
        description: Organization name
        required: true
        schema:
          type: string
      requestBody:
        description: Ingest data (multiple line json)
        content:
          application/json:
            schema:
              type: string
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              example:
                code: 200
                status:
                - name: olympics
                  successful: 3
                  failed: 0
        '500':
          description: Failure
          content:
            application/json:
              schema:
                default: null
      security:
      - Authorization: []
      x-o2-mcp:
        enabled: false
components:
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: Authorization
    BasicAuth:
      type: http
      scheme: basic