Forsta Watermarked Videos API

openapi: 3.2.0
info:
  title: Decipher Rest Watermarked Videos 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: Watermarked Videos
paths:
  /surveys/{survey}/videos/{video_id}:
    put:
      operationId: updateSurveyVideo
      summary: Increase unique watermarked videos
      description: Increases the number of unique videos
      tags:
      - Watermarked Videos
      parameters:
      - $ref: '#/components/parameters/survey'
      - name: video_id
        description: The ID of the video to update.
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                quantity:
                  description: 'The new total number of unique videos. Difference between old and

                    new quantities cannot exceed 10,000 (i.e., only 10,000 more can

                    be requested at a time.)

                    '
                  type: string
                keep:
                  description: 'If true then the video will be flagged so as it is not deleted

                    by the cleanup scripts.

                    '
                  type: boolean
                privacy:
                  description: 'Set this to change the privacy level of the video.

                    '
                  type: string
                  enum:
                  - unused
                  - survey
                  - company
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
  /surveys/{survey}/videos/{video_id}/create_db_file:
    post:
      operationId: createSurveyVideoCreateDBFile
      summary: Create watermark file
      description: 'Create a file containing a single column of `{video_id}.{watermark_id}`,

        which the Video Player DQ uses to uniquely assign videos to participants.'
      tags:
      - Watermarked Videos
      parameters:
      - $ref: '#/components/parameters/survey'
      - description: ID of the watermarked video.
        in: path
        name: video_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  database_file:
                    type: string
              example:
                database_file: watermark_videos_12323543345.txt
  /surveys/{survey}/videos/{video_id}/watermark_videos:
    get:
      operationId: getSurveyVideosWatermarkVideos
      summary: List watermarked videos
      description: Get the list of watermarks and video IDs.
      tags:
      - Watermarked Videos
      parameters:
      - $ref: '#/components/parameters/survey'
      - name: video_id
        description: ID of the watermarked video to retrieve.
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    video_id:
                      type: string
                    watermark_id:
                      type: string
                example:
                - video_id: '93472979349'
                  watermark_id: 87fg8gd8
                - video_id: '93472979349'
                  watermark_id: 87fg8gd8
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