openapi: 3.1.0
info:
  title: Sisense REST Authentication Dashboards API
  description: The Sisense REST API provides programmatic access to the Sisense business intelligence platform, enabling management of dashboards, data models (Elasticubes and live models), users, groups, data security rules, and builds. The API uses Bearer token authentication obtained via the login endpoint or User Profiles settings. Endpoints follow RESTful conventions with standard HTTP methods for CRUD operations.
  version: v1
  contact:
    name: Sisense Support
    url: https://support.sisense.com/
  termsOfService: https://www.sisense.com/legal/terms-of-service/
  license:
    name: Commercial
    url: https://www.sisense.com/legal/terms-of-service/
servers:
- url: https://{host}/api/v1
  description: Sisense Instance REST API v1
  variables:
    host:
      description: Your Sisense instance hostname
      default: your-instance.sisense.com
security:
- bearerAuth: []
tags:
- name: Dashboards
  description: Create, read, update, and manage dashboards
paths:
  /dashboards:
    get:
      operationId: listDashboards
      summary: List Dashboards
      description: Returns a list of dashboards accessible to the authenticated user. Supports filtering by various attributes.
      tags:
      - Dashboards
      parameters:
      - name: fields
        in: query
        description: Comma-separated list of fields to include in response
        required: false
        schema:
          type: string
      - name: sort
        in: query
        description: Field to sort by (prefix with - for descending)
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of results to return
        required: false
        schema:
          type: integer
      - name: skip
        in: query
        description: Number of results to skip for pagination
        required: false
        schema:
          type: integer
      - name: expand
        in: query
        description: Replace foreign key IDs with full entity objects
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Dashboards retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dashboard'
        '401':
          description: Unauthorized - invalid or missing token
    post:
      operationId: createDashboard
      summary: Create Dashboard
      description: Creates a new dashboard in Sisense.
      tags:
      - Dashboards
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDashboardRequest'
      responses:
        '200':
          description: Dashboard created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
        '401':
          description: Unauthorized
  /dashboards/{id}:
    get:
      operationId: getDashboard
      summary: Get Dashboard
      description: Returns a specific dashboard by ID.
      tags:
      - Dashboards
      parameters:
      - name: id
        in: path
        required: true
        description: Dashboard identifier
        schema:
          type: string
      - name: fields
        in: query
        description: Fields to include in response
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Dashboard retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
        '404':
          description: Dashboard not found
    delete:
      operationId: deleteDashboard
      summary: Delete Dashboard
      description: Deletes a dashboard by ID.
      tags:
      - Dashboards
      parameters:
      - name: id
        in: path
        required: true
        description: Dashboard identifier
        schema:
          type: string
      responses:
        '200':
          description: Dashboard deleted successfully
        '404':
          description: Dashboard not found
  /dashboards/admin:
    get:
      operationId: listAllDashboards
      summary: List All Dashboards (Admin)
      description: Admin endpoint that returns all dashboards across all users. Requires admin privileges.
      tags:
      - Dashboards
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      - name: skip
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: All dashboards retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dashboard'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden - admin privileges required
components:
  schemas:
    Dashboard:
      type: object
      properties:
        oid:
          type: string
          description: Dashboard unique identifier
        title:
          type: string
          description: Dashboard display title
        desc:
          type: string
          description: Dashboard description
        owner:
          type: string
          description: Dashboard owner user ID
        folder:
          type: string
          description: Parent folder ID
        shares:
          type: array
          description: List of share permissions
          items:
            type: object
        created:
          type: string
          format: date-time
          description: Dashboard creation timestamp
        lastUpdated:
          type: string
          format: date-time
          description: Last update timestamp
        type:
          type: string
          description: Dashboard type identifier
    CreateDashboardRequest:
      type: object
      required:
      - title
      properties:
        title:
          type: string
          description: Dashboard title
        desc:
          type: string
          description: Dashboard description
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token obtained from POST /api/v1/authentication/login
externalDocs:
  description: Sisense REST API Documentation
  url: https://developer.sisense.com/guides/restApi/