OpenReplay

opencollection: 1.0.0
info:
  name: OpenReplay API
  version: '2.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Projects
    type: folder
  items:
  - info:
      name: List projects
      type: http
    http:
      method: GET
      url: https://api.openreplay.com/v2/public/projects
    docs: Retrieve all projects belonging to the authenticated tenant.
  - info:
      name: Create project
      type: http
    http:
      method: POST
      url: https://api.openreplay.com/v2/public/projects
      body:
        type: json
        data: '{}'
    docs: Create a new project for the authenticated tenant.
  - info:
      name: Get project
      type: http
    http:
      method: GET
      url: https://api.openreplay.com/v2/public/projects/:projectKey
      params:
      - name: projectKey
        value: ''
        type: path
        description: Unique project key.
    docs: Retrieve a single project by its `projectKey`.
- info:
    name: Users
    type: folder
  items:
  - info:
      name: Search users
      type: http
    http:
      method: POST
      url: https://api.openreplay.com/v2/public/:projectKey/users
      params:
      - name: projectKey
        value: ''
        type: path
        description: Unique project key.
      body:
        type: json
        data: '{}'
    docs: Filter users by attributes (id, email, country, etc.) and paginate the results.
  - info:
      name: Get user
      type: http
    http:
      method: GET
      url: https://api.openreplay.com/v2/public/:projectKey/users/:userId
      params:
      - name: projectKey
        value: ''
        type: path
        description: Unique project key.
      - name: userId
        value: ''
        type: path
        description: User identifier set via `tracker.setUserID`.
    docs: Retrieve identity attributes and aggregate statistics for a single user.
  - info:
      name: Delete user
      type: http
    http:
      method: DELETE
      url: https://api.openreplay.com/v2/public/:projectKey/users/:userId
      params:
      - name: projectKey
        value: ''
        type: path
        description: Unique project key.
      - name: userId
        value: ''
        type: path
        description: User identifier set via `tracker.setUserID`.
    docs: Schedule a background job to delete a user and all of their associated data.
- info:
    name: Sessions
    type: folder
  items:
  - info:
      name: List user sessions
      type: http
    http:
      method: POST
      url: https://api.openreplay.com/v2/public/:projectKey/users/:userId/sessions
      params:
      - name: projectKey
        value: ''
        type: path
        description: Unique project key.
      - name: userId
        value: ''
        type: path
        description: User identifier set via `tracker.setUserID`.
      body:
        type: json
        data: '{}'
    docs: Return sessions for a particular user (identified via `tracker.setUserID`). Paginated.
- info:
    name: Events
    type: folder
  items:
  - info:
      name: List session events
      type: http
    http:
      method: POST
      url: https://api.openreplay.com/v2/public/:projectKey/sessions/:sessionId/events
      params:
      - name: projectKey
        value: ''
        type: path
        description: Unique project key.
      - name: sessionId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Returns events (clicks, page visits, inputs, custom events, etc.) captured in a specific session.
- info:
    name: Jobs
    type: folder
  items:
  - info:
      name: List jobs
      type: http
    http:
      method: GET
      url: https://api.openreplay.com/v2/public/:projectKey/jobs
      params:
      - name: projectKey
        value: ''
        type: path
        description: Unique project key.
      - name: limit
        value: ''
        type: query
      - name: page
        value: ''
        type: query
    docs: Retrieve all jobs for a project, including completed and cancelled ones. Paginated.
  - info:
      name: Get job
      type: http
    http:
      method: GET
      url: https://api.openreplay.com/v2/public/:projectKey/jobs/:jobId
      params:
      - name: projectKey
        value: ''
        type: path
        description: Unique project key.
      - name: jobId
        value: ''
        type: path
    docs: Return a job's status and metadata.
  - info:
      name: Cancel job
      type: http
    http:
      method: DELETE
      url: https://api.openreplay.com/v2/public/:projectKey/jobs/:jobId
      params:
      - name: projectKey
        value: ''
        type: path
        description: Unique project key.
      - name: jobId
        value: ''
        type: path
    docs: Cancel a job that hasn't started yet or is still in progress.
- info:
    name: Assist
    type: folder
  items:
  - info:
      name: List live sessions
      type: http
    http:
      method: GET
      url: https://api.openreplay.com/v2/public/:projectKey/assist/sessions
      params:
      - name: projectKey
        value: ''
        type: path
        description: Unique project key.
      - name: userId
        value: ''
        type: query
    docs: Return live sessions for the project. Optionally filter by `userId`. Enterprise Edition only.
  - info:
      name: Search live sessions
      type: http
    http:
      method: POST
      url: https://api.openreplay.com/v2/public/:projectKey/assist/sessions
      params:
      - name: projectKey
        value: ''
        type: path
        description: Unique project key.
      body:
        type: json
        data: '{}'
    docs: Search live sessions using filtering, sorting, and pagination options. Enterprise Edition only.
bundled: true