openapi: 3.2.0
info:
  title: Decipher Rest Response Summary 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: Response Summary
paths:
  /surveys/{survey}/summary/completions:
    get:
      operationId: getSurveySummaryCompletions
      summary: List completions
      description: 'Returns the equivalent of the “Completions” tab in the Response Summary

        report (formerly known as field report).'
      tags:
      - Response Summary
      parameters:
      - $ref: '#/components/parameters/survey'
      - name: split
        in: query
        description: If supplied, create segments for this split.
        schema:
          type: string
          example: list
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  segments:
                    type: array
                    description: 'List of segment names, e.g. “Total”, “Participant

                      source (list=1)” similar to column names when splitting.

                      '
                    items:
                      type: string
                  rows:
                    type: array
                    description: 'List with one object per a row that would be displayed

                      in the Completions tab

                      '
                    items:
                      type: object
                      properties:
                        formula:
                          type: string
                          description: 'The formula used to compute the value.

                            This should be used to search for specific values.

                            '
                          example: clickthrough
                        cells:
                          type: array
                          description: 'one object for each segment the response summary is

                            split by

                            '
                          items:
                            type: object
                            properties:
                              vsplit:
                                type: string
                                description: 'The split identifier. This can be passed to the

                                  variables down URL (`/rep/{survey}:vars?only=VSPLIT`)

                                  and this is what the “Clickthrough” cell links to

                                  in the response summary user interface.

                                  '
                                example: ''
                              raw:
                                type: number
                                description: 'The raw numeric value

                                  '
                                format: float
                                example: 0.76
                              formatted:
                                oneOf:
                                - type: string
                                  example: 76%
                                - type: integer
                                  example: 500
                                description: 'The formatted value.

                                  '
                              title:
                                type: string
                        name:
                          type: string
                        title:
                          type: string
      x-codeSamples:
      - lang: Curl
        source: 'curl -H x-apikey: {api_key} -X GET {server}/api/v1/surveys/{survey}/summary/completions?split=list

          '
      - lang: Cli
        source: 'beacon get surveys/{survey}/summary/completions split=list > myfile.json

          '
  /surveys/{survey}/summary/campaigns:
    get:
      operationId: getSurveySummaryCampaigns
      summary: List campaigns
      description: 'Returns the equivalent of the “Campaigns” tab in the Response Summary report

        (formerly known as field report).'
      tags:
      - Response Summary
      parameters:
      - $ref: '#/components/parameters/survey'
      - $ref: '#/components/parameters/split'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  segments:
                    type: array
                    description: 'List of segment names, e.g. “Total”, “Participant

                      source (list=1)” similar to column names when splitting.

                      '
                    items:
                      type: string
                  rows:
                    type: array
                    description: 'List with one object per row that would be displayed

                      in the Campaigns tab

                      '
                    items:
                      type: object
                      properties:
                        formula:
                          type: string
                          description: 'The formula used to compute the value.

                            This should be used to search for specific values.

                            '
                          example: clickthrough
                        cells:
                          type: array
                          description: 'one object for each segment the response summary is

                            split by

                            '
                          items:
                            type: object
                            properties:
                              vsplit:
                                type: string
                                description: 'The split identifier. This can be passed to the

                                  variables down URL (`/rep/{survey}:vars?only=VSPLIT`)

                                  and this is what the “Clickthrough” cell links to

                                  in the response summary user interface.

                                  '
                                example: ''
                              raw:
                                type: number
                                description: The raw numeric value
                                format: float
                                example: 0.76
                              formatted:
                                type: string
                                example: 76%
                                description: The formatted value.
                              title:
                                type: string
                        name:
                          type: string
                        title:
                          type: string
                  reminders:
                    type: object
                    properties:
                      total_sent:
                        type: array
                      rows:
                        type: array
                  intitial_sends:
                    type: array
                    items:
                      type: object
      x-codeSamples:
      - lang: Curl
        source: 'curl -H x-apikey: {api_key} -X GET {server}/api/v1/surveys/{survey}/summary/campaigns?split=list

          '
      - lang: Cli
        source: 'beacon get surveys/{survey}/summary/campaigns split=list > myfile.json

          '
  /surveys/{survey}/summary/splits:
    get:
      operationId: getSurveySummarySummarySplits
      summary: List splits
      description: 'Returns the split names you can split the response summary report by. These

        are typically extraVariables that have a fixed set of values (e.g. list,

        decLang).'
      tags:
      - Response Summary
      parameters:
      - $ref: '#/components/parameters/survey'
      - name: campaigns
        in: query
        description: Include campaign specific splits.
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      description: 'The symbolic name that can be passed as split into the other

                        response summary APIs

                        '
                    description:
                      type: string
                      description: Additional description
                    segments:
                      type: array
                      description: 'List of segment names, e.g. “Total”, “Participant

                        source (list=1)” similar to column names when splitting.

                        '
                      items:
                        type: string
      x-codeSamples:
      - lang: Curl
        source: 'curl -H x-apikey: {api_key} -X GET {server}/api/v1/surveys/{survey}/summary/completions?split=list

          '
      - lang: Cli
        source: 'beacon get surveys/{survey}/summary/completions split=list > myfile.json

          '
components:
  parameters:
    survey:
      name: survey
      in: path
      required: true
      description: The survey path.
      example: selfserve/1a/123456
      schema:
        type: string
        format: uri
    split:
      name: split
      in: query
      description: If supplied, create segments for this split.
      schema:
        type: string
        example: list
  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