Forsta Survey Warnings API

openapi: 3.2.0
info:
  title: Decipher Rest Survey Warnings 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: Survey Warnings
paths:
  /surveys/{survey}/warnings:
    get:
      operationId: getSurveyWarnings
      summary: Get warnings
      description: 'Retrieve project warnings for a survey.

        Only events experienced by non-users (i.e., logged-out participants) in non-testing surveys

        are reported. Best efforts are made to eliminate duplicate events from the results.'
      tags:
      - Survey Warnings
      parameters:
      - $ref: '#/components/parameters/survey'
      - name: start
        in: query
        description: restrict events returned to just those occurring on/after this date
        example: '2021-01-01'
        schema:
          type: string
          format: ISO-8601
      - name: end
        in: query
        description: restrict warnings counts to just those occurring on/before this date
        example: '2021-01-01'
        schema:
          type: string
          format: ISO-8601
      - name: types
        in: query
        description: restrict events returned to just these types
        example: exceptions
        schema:
          type: string
          default: blocks,missing_resources,exceptions,quota_misses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  company:
                    description: company ID
                    example: 1
                    type: integer
                  counts:
                    description: Full event counts
                    type: object
                  events:
                    description: 'An array of events consisting of the following properties

                      (subject to data retention rules)

                      '
                    type: array
                    items:
                      type: object
                      properties:
                        timestamp:
                          type: string
                          format: timestamp
                          description: time of event occurrence or observation
                        type:
                          type: string
                          description: event type
                          enum:
                          - blocks
                          - missing_resources
                          - exceptions
                          - quota_misses
                        details:
                          type: object
                          description: an object consisting of properties that are specific to the event type
                  name:
                    description: Survey name
                    example: survey123
                    type: string
                  path:
                    description: Survey path
                    example: selfserve/53a/210401
                    type: string
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