Forsta Crosstabs Rim Weighting API

openapi: 3.2.0
info:
  title: Decipher Rest Crosstabs Rim Weighting 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: Crosstabs Rim Weighting
paths:
  /surveys/{survey}/crosstabs/weighting/rim/{var}:
    put:
      operationId: updateSurveyCrosstabsWeightingRim
      summary: Update rim weighting
      tags:
      - Crosstabs Rim Weighting
      description: Create per-record weights based on a set of RIM variables and breaks. The algorithm as described in the Wincross manual is used.
      parameters:
      - name: survey
        description: survey path to run crosstabs in
        in: path
        required: true
        schema:
          type: string
      - name: var
        description: The target var to save the data in. This will be created as a new or updated column in the `nweight.txt` file.
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                iterations:
                  description: 'How many times should we try to approximate the variables.

                    '
                  default: 50
                  type: integer
                minWeight:
                  description: Minimum acceptable record weight.
                  default: 0.0001
                  type: number
                maxWeight:
                  description: 'Maximum acceptable record weight (by default, no limit).

                    '
                  default: 999999
                  type: number
                converge:
                  description: 'Acceptable convergence to consider the test done before

                    completing all iterations.

                    '
                  default: 5.0e-06
                  type: number
                test:
                  description: 'In test mode, do not save the data but still run the calculations.

                    '
                  default: false
                  type: boolean
                chunks:
                  description: 'An array of objects, containing `precondition` and `variables`.

                    Each variable is an array for each variable (e.g. Gender) to test

                    containing an array of objects that are values. Each value is a

                    crosstabs condition and the desired percentage ratio (must add up

                    to 100%).

                    '
                  type: array
                  items:
                    type: object
                    properties:
                      precondition:
                        type: string
                      variables:
                        type: array
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              condition:
                                type: string
                              ratio:
                                type: array
                                minItems: 2
                                maxItems: 2
              required:
              - chunks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    success:
                      type: boolean
                      description: 'True if we managed to hit convergence within the required

                        number of iterations.

                        '
                    rms:
                      type: number
                      description: 'Root mean square of the last iteration, which is compared to

                        the desired convergence.

                        '
                    debug:
                      type: string
                      description: 'Textual debug information about what happened in each

                        iteration.

                        '
                    efficiency:
                      type: number
                      description: Efficiency factor of generated weights.
                    wprop:
                      type: object
                      description: achieved weights per break in each variable.
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