openapi: 3.2.0
info:
  title: Decipher Rest Dashboards API
  version: '1.0'
  description: The Decipher REST API allows comprehensive automation of your private or shared Decipher instance.
servers:
- url: https://{server}/api/v1
  description: Replace server with your instance domain.
  variables:
    server:
      default: selfserve.decipherinc.com
      description: Server domain
security:
- APIKey: []
tags:
- name: Dashboards
paths:
  /surveys/{survey}/dashboards:
    get:
      operationId: getSurveyDashboards
      summary: List dashboards
      description: Returns a list of all dashboards for the given survey.
      tags:
      - Dashboards
      parameters:
      - $ref: '#/components/parameters/survey'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      description: The unique identifier for the dashboard
                      example: 7dzxw12nm3f0
                      type: string
                    title:
                      description: The title of the dashboard
                      example: Private Dashboard
                      type: string
                    public:
                      description: Is the dashboard public?
                      example: false
                      type: boolean
                    published:
                      description: Has the dashboard been published?
                      example: true
                      type: boolean
                    published_link:
                      description: 'If the dashboard has been published, it may be viewed at this

                        link. If it is a private dashboard, the user must be logged

                        in to view it.

                        '
                      example: https://example.decipherinc.com/apps/dashboard/selfserve/1a/123456:view/7dzxw12nm3f0
                      type: string
  /surveys/{survey}/dashboards/{id}:
    get:
      operationId: getSurveyDashboard
      summary: Get dashboard
      description: Returns the dashboard with the given id for the given survey.
      tags:
      - Dashboards
      parameters:
      - $ref: '#/components/parameters/survey'
      - name: id
        in: path
        description: The id of the dashboard you wish to get
        example: 7dzxw12nm3f0
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    description: The unique identifier for the dashboard
                    example: 7dzxw12nm3f0
                    type: string
                  title:
                    description: The title of the dashboard
                    example: Private Dashboard
                    type: string
                  public:
                    description: Is the dashboard public?
                    example: false
                    type: boolean
                  published:
                    description: Has the dashboard been published?
                    example: true
                    type: boolean
                  published_link:
                    description: 'If the dashboard has been published, it may be viewed at this

                      link. If it is a private dashboard, the user must be logged

                      in to view it.

                      '
                    example: https://example.decipherinc.com/apps/dashboard/selfserve/1a/123456:view/7dzxw12nm3f0
                    type: string
    put:
      operationId: updateSurveyDashboard
      summary: Update dashboard
      description: Publish or unpublish a dashboard.
      tags:
      - Dashboards
      parameters:
      - $ref: '#/components/parameters/survey'
      - name: id
        in: path
        description: The unique identifier of the dashboard
        example: 7dzxw12nm3f0
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                published:
                  description: Should the dashboard be published?
                  type: boolean
              required:
              - published
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    description: The unique identifier for the dashboard
                    example: 7dzxw12nm3f0
                    type: string
                  title:
                    description: The title of the dashboard
                    example: Private Dashboard
                    type: string
                  public:
                    description: Is the dashboard public?
                    example: false
                    type: boolean
                  published:
                    description: Has the dashboard been published?
                    example: true
                    type: boolean
                  published_link:
                    description: 'If the dashboard has been published, it may be viewed at this

                      link. If it is a private dashboard, the user must be logged

                      in to view it.

                      '
                    example: https://example.decipherinc.com/apps/dashboard/selfserve/1a/123456:view/7dzxw12nm3f0
                    type: string
    delete:
      operationId: deleteSurveyDashboard
      summary: Delete dashboard
      description: Deletes the given dashboard.
      tags:
      - Dashboards
      parameters:
      - $ref: '#/components/parameters/survey'
      - name: id
        in: path
        description: The unique identifier for the dashboard
        example: 7dzxw12nm3f0
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties: {}
components:
  parameters:
    survey:
      name: survey
      in: path
      required: true
      description: The survey path.
      example: selfserve/1a/123456
      schema:
        type: string
        format: uri
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: x-apikey
      description: 'In order to access the api, you''ll need to generate an API key. Refer to the

        instructions [here](/docs/decipher/api#section/API-Keys) to generate and

        configure an API key with the appropriate permission sets. You can generate

        as many keys as required.


        Configure each request to include your API key in the request header. For example:


        ```

        x-apikey: dp48ss3mgsaucyjtybxw728h7s4cgnwzhejtszdwhf4xpe8yhmtdwpk2ntdhtwbs

        ```

        '
x-tagGroups:
- name: Autoclose
  tags:
  - Autoclose
- name: Data Input and Output
  tags:
  - Data
  - Data Feed
  - Response Summary
  - Modifying Data
  - Datasources
  - Datasources Data
  - Umerge
- name: Survey Metadata
  tags:
  - Simulated Data
  - Survey State
  - Survey Evaluate
  - Survey Quotas
  - Survey Files
  - Survey Warnings
  - Survey Terms
  - Survey Subscribers
  - Survey Users
  - Survey Tasks
- name: Panels
  tags:
  - Panel Data
  - Panel Datapoints
  - Survey Panels
- name: Research Hub
  tags:
  - Users
  - Companies
  - Categories
  - Surveys
  - Panels
  - Crosstabs
  - Archives
  - Archival Reports
  - API Keys
  - Usage
  - Warnings Summary
- name: Crosstabs
  tags:
  - Crosstabs Configuration
  - Crosstabs Execution
  - Crosstabs Nets
  - Saved Crosstabs
  - Crosstabs Table Settings
  - Crosstabs Validation
  - Crosstabs Rim Weighting
- name: Dashboards
  tags:
  - Dashboards
- name: DQ APIs
  tags:
  - DQ-Specific API Calls
  - MaxDiff API Calls
  - Discrete Choice Model API Calls
  - Media Testimonial API Calls
- name: Response Summary
  tags:
  - Share Link
- name: Sample Management
  tags:
  - Bounced Emails
  - Participant Sources
- name: Distribution
  tags:
  - Email Distribution
  - SFTP Distribution
  - Slack Distribution
- name: Campaign Manager
  tags:
  - Campaigns
  - Campaign Email Invites
  - Campaign Exports
  - Campaign Lists
  - Shared Campaign Lists
  - Campaign Sends
  - Campaign Status Lists
  - Supression Lists
- name: Question Library
  tags:
  - Company Element
  - Company Elements
  - Survey Elements
  - Survey Element Report Settings
- name: Language Manager
  tags:
  - LM Application Data
  - LM Application Translations
  - Translation Resources
  - Translations
  - Translation Deltas
  - Translation Reservations
  - Primary Survey Language
  - Other Survey Languages
  - Unused Survey Languages
- name: Project Parameters
  tags:
  - Available Project Parameters
  - Saved Project Parameters
  - Project Parameters Configuration
- name: Multi-User Editing
  tags:
  - Available Sections
  - Check Out Section
  - Check In Section
  - Sync Section
  - Section Editor
  - Abandon Section
  - Validate Section
- name: Video Management
  tags:
  - Videos
  - Watermarked Videos
- name: Miscellaneous
  tags:
  - System Information
  - Logic Nodes
  - Logic Events
  - CATI
  - Global Search
  - Miscellaneous