Forsta Global Search API

openapi: 3.2.0
info:
  title: Decipher Rest Global Search 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: Global Search
paths:
  /globalsearch/emails:
    post:
      operationId: createGlobalsearchEmails
      summary: Search for email usage
      description: Find participants who were sent an email through our "bulk email" system (excludes e.g. email logic node). You must have download permission for the matched surveys to view the results. Only the initial (i.e. not reminder) send is output. A send must have been attempted to the recipient for this API to output the email.
      tags:
      - Global Search
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                emails:
                  type: array
                  description: an array of emails addresses to search for
                  items:
                    type: string
              required:
              - emails
            example:
              emails:
              - xhargn@aol.com
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    survey:
                      type: string
                      description: survey path from which the email send was done
                    date:
                      type: string
                      description: date and time of send
                    email:
                      type: string
                      description: email address
                    listfile:
                      type: string
                      description: 'full path to the list file that was sent (this file may have

                        been archived)

                        '
                    listvars:
                      type:
                      - object
                      - 'null'
                      description: 'object with data stored in the list file for that participant,

                        or null

                        '
                    uuid:
                      type:
                      - string
                      - 'null'
                      description: 'UUID of the user if they started the survey or null if we

                        couldn''t find them (didn''t click through)

                        '
                    error:
                      type:
                      - string
                      - 'null'
                      description: 'either null, no-listfile (list file does not exist), or

                        no-entry (email no longer exists in listfile)

                        '
                    status:
                      type:
                      - string
                      - 'null'
                      description: 'if not null, the participant started the survey and ended up

                        with this status code

                        '
              example:
              - date: '2014-11-20T00:27:12Z'
                email: xhargn@aol.com
                error: null
                listfile: /home/erwin/h/portal/demo/tiny/mail/list.txt
                listvars:
                  email: xhargn@aol.com
                  source: 9cdajm
                status: p
                survey: demo/tiny
                uuid: ens2j0zfyc5swn79
              - date: '2016-05-18T20:43:56Z'
                email: xhargn@aol.com
                error: no-listfile
                listfile: /home/erwin/h/portal/demo/tiny/mail/list2.txt
                listvars: null
                status: null
                survey: demo/tiny
                uuid: null
          description: OK
  /globalsearch/evars:
    post:
      operationId: createGlobalsearchEvars
      summary: Search for extra variable usage
      description: 'Find participants with certain extra variable values. Participant data is retained for three years by default, but may be configured differently on your server. A maximum of 1000 records are returned. Requires data:download permission for the matched surveys to view results. Note that for a full data search on a "v2" system, expect a latency of 180 seconds. Only one global search call can run at a time: if you get an error, prepare to retry with a delay.'
      tags:
      - Global Search
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                evars:
                  type: array
                  description: An array of 2-element arrays, where the first element is an evar name, and the second element is the value
                  items:
                    type: array
                    items:
                      type: string
                    minItems: 2
                    maxItems: 2
                start:
                  type: string
                  description: Minimum date. Set this to a more recent value for a faster response time.
                  default: '2015-01-01'
              required:
              - evars
            example:
              start: '2019-03-14'
              evars:
              - - list
                - '1'
              - - list
                - '3'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    date:
                      type: string
                      description: date and time
                    survey:
                      type: string
                      description: survey path
                    uuid:
                      type: string
                      description: uuid of the participant
                    vars:
                      type: object
                      description: map of evars and values
              example:
              - date: '2016-02-24T21:46:06Z'
                survey: demo/datain
                uuid: e327es8jnzh74v39
                vars:
                  list: '1'
              - date: '2016-02-24T21:46:06Z'
                survey: demo/datain
                uuid: j3hgwyh386qj253w
                vars:
                  list: '1'
              - date: '2016-02-24T21:46:06Z'
                survey: demo/datain
                uuid: 5ebg11gh4xea266b
                vars:
                  list: '3'
          description: OK
          headers: {}
components:
  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