Forsta Usage API

openapi: 3.2.0
info:
  title: Decipher Rest Usage 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: Usage
paths:
  /rh/usage:
    get:
      operationId: getRHUsage
      summary: Calculate usage
      description: 'Outputs the data generated by the usage page combined with a breakdown of

        qualifieds by device type. Note that this data is only accessible 24-48 hours

        after; yesterday''s participant data is processed overnight.


        This is a staff-only API endpoint.'
      tags:
      - Usage
      parameters:
      - name: start
        description: start date
        in: query
        required: true
        schema:
          type: string
      - name: end
        description: end date
        in: query
        required: true
        schema:
          type: string
      - name: company
        description: restrict only to this company's stats
        in: query
        required: false
        schema:
          type: string
      - name: excludeDecipher
        description: exclude Decipher-launched projects
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  qualified_devices:
                    type: object
                    description: qualifieds by device
                    properties:
                      .:
                        type: integer
                        description: desktop
                      f:
                        type: integer
                        description: featurephone
                      s:
                        type: integer
                        description: smartphone
                      m:
                        type: integer
                        description: misc mobile device
                      t:
                        type: integer
                        description: tablet
                  clickthrough_devices:
                    type: object
                    description: clickthroughs by device
                    properties:
                      .:
                        type: integer
                        description: desktop
                      f:
                        type: integer
                        description: featurephone
                      s:
                        type: integer
                        description: smartphone
                      m:
                        type: integer
                        description: misc mobile device
                      t:
                        type: integer
                        description: tablet
                  users:
                    type: integer
                    description: distinct active users
                  surveys:
                    type: integer
                    description: distinct active live surveys
                  clickthrough:
                    type: integer
                    description: total clickthroughts in live surveys
                  qualifiedCompletes:
                    type: integer
                    description: total qualifiedss
                  surveyPaths:
                    type: array
                    description: 'survey paths involved in the active live surveys calculation

                      '
                    items:
                      type: string
                  overquota:
                    type: integer
                    description: total overquota
                  terminated:
                    type: integer
                    description: total terminated
                  emailSends:
                    type: integer
                    description: number of emails sent
                  emailCampaigns:
                    type: integer
                    description: number of email campaigns
                  spamComplaints:
                    type: integer
                    description: numer of spam complaints
                  spamRate:
                    type: integer
                    description: spam rate
                  launchedSurveys:
                    type: integer
                    description: number of launched surveys
                  event_*:
                    type: integer
                    description: 'detailed usage stats (reports run, dashboards created, etc)

                      '
                  hubStorage:
                    type: integer
                    description: hub storage
                  importedCompletes:
                    type: integer
                    description: number of imported completes
                  cleanedData:
                    type: integer
                  publishedDashboards:
                    type: integer
                    description: number of published dashboards
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