openapi: 3.0.1
info:
  description: The Touchpoints API allows agencys users to programatically read Forms and Responses.
  version: 0.0.0
  title: Touchpoints API
  contact:
    name: Touchpoints
    url: 'https://touchpoints.digital.gov'
    email: feedback-analytics@gsa.gov
servers:
  - url: 'https://api.data.gov/analytics/touchpoints/v0/'
    variables:
      scheme:
        description: API responses are available via https only
        enum:
          - https
        default: https
tags:
  - name: cx
    description: Customer Experience
  - name: feedback
    description: Customer feedback responses
  - name: surveys
    description: Customer feedback surveys
  - name: performance management
    description: Performance Management
paths:
  /forms:
    get:
      summary: List available data sets
      operationId: forms
      tags:
        - forms
        - surveys
      responses:
        '200':
          description: Returns an array of forms
          content:
            application/json:
              schema:
                type: object
                properties:
                  forms:
                    type: array
                    items:
                      $ref: '#/components/schemas/Form'
  '/forms/{short-uuid}/':
    get:
      summary: Provides the general information about the API and the list of fields that can be used to query the dataset.
      description: This GET API returns the list of all the searchable field names that are in the oa_citations. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the syntax options shown below.
      operationId: forms#show
      tags:
        - forms
        - surveys
        - submissions
        - responses
        - feedback
      parameters:
        - name: short-uuid
          in: path
          description: Short UUID of the form
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The dataset API for the given version is found and it is accessible to consume.
          content:
            application/json:
              schema:
                type: object
                properties:
                  form:
                    type: object
                    $ref: '#/components/schemas/Form'

components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
  schemas:
    Form:
      type: object
      required:
        - id
      properties:
        uuid:
          type: string
          format: uuid
        id:
          type: integer
          format: int32
        organization_id:
          type: integer
          format: int32
        name:
          type: string
        instructions:
          type: string
        kind:
          type: string
        notes:
          type: string
        status:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        element_selector:
          type: string
        whitelist_url:
          type: string
        whitelist_url_1:
          type: string
        whitelist_url_2:
          type: string
        whitelist_url_3:
          type: string
        whitelist_url_4:
          type: string
        whitelist_url_5:
          type: string
        whitelist_url_6:
          type: string
        whitelist_url_7:
          type: string
        whitelist_url_8:
          type: string
        whitelist_url_9:
          type: string
        whitelist_test_url:
          type: string
        header_logo_display:
          type: string
          enum:
            - banner
            - square
        early_submission:
          type: boolean
        template:
          type: boolean
        load_css:
          type: boolean
        logo:
          type: object
        success_text:
          type: string
        modal_button_text:
          type: string
        omb_approval_number:
          type: string
        expiration_date:
          type: string
        federal_register_url:
          type: string
        service_name:
          type: string
        survey_instrument_reference:
          type: string
        survey_form_activations:
          type: integer
          format: int32
        anticipated_delivery_count:
          type: integer
          format: int32
        submissions:
          $ref: '#/components/schemas/Submissions'
    Forms:
      type: array
      items:
        $ref: '#/components/schemas/Form'
    Submission:
      type: object
      required:
        - form_id
      properties:
        form_id:
          type: string
        user_id:
          type: integer
        uuid:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        referer:
          type: string
        page:
          type: string
        user_agent:
          type: string
        answer_01:
          type: string
        answer_02:
          type: string
        answer_03:
          type: string
        answer_04:
          type: string
        answer_05:
          type: string
        answer_06:
          type: string
        answer_07:
          type: string
        answer_08:
          type: string
        answer_09:
          type: string
        answer_10:
          type: string
        answer_11:
          type: string
        answer_12:
          type: string
        answer_13:
          type: string
        answer_14:
          type: string
        answer_15:
          type: string
        answer_16:
          type: string
        answer_17:
          type: string
        answer_18:
          type: string
        answer_19:
          type: string
        answer_20:
          type: string
        answer_21:
          type: string
        answer_22:
          type: string
        answer_23:
          type: string
        answer_24:
          type: string
        answer_25:
          type: string
        answer_26:
          type: string
        answer_27:
          type: string
        answer_28:
          type: string
        answer_29:
          type: string
        answer_30:
          type: string
        ip_address:
          type: string
        location_code:
          type: string
        flagged:
          type: boolean
        language:
          type: string
    Submissions:
      type: array
      items:
        $ref: '#/components/schemas/Submission'