SurveyQuotas Returned Fields

 Help Us Improve Our API Documentation!

We're beginning an initiative to improve our API docs. We would love your help!

Please take this quick 4-question survey to help us out! Thank you in advance for your time!

Returned fields for the SurveyQuotas sub-object are explained below. Go to the Example Returns section to view return examples for each call type.

Returned Fields for the SurveyQuotas Object

FieldDescriptionFormat
idQuota IDnumber
nameQuota Name
string
descriptionQuota Description
string
responsesNumber of responses within quota
number
limitQuota limit
number
distributedIndicates whether quota is distributed logic type
boolean
groupsArray of all quota conditions
array
Groups FieldsDescriptionFormat
idQuota Group IDstring
rules
Array of separate quota rules
array
Rules FieldsDescriptionFormat
idQuota Rule IDstring
input_value
Survey question, System Data, etc.
number/string
operator
Logic condition i.e. "is exactly equal to"number
answers_type
Indicates whether the answer is open-text/input
number
answers_values
Values on which quota conditions are based i.e. an answer to a specific question
number/string
rule_percentage (distributed=true)Percentage distribution among quota rules within a single group (must equal 100 among rules in one group)
number
next_operator (distributed=false)
The operator joining separate groups within a quota or separate rules within a group (must be either "or" or "and")
string

Example Returns (.json format)

GetList Return Example (.json format):

{
  "result_ok": true,
  "quotas": [
    {
      "id": "123",
      "name": "Female Quota",
      "description": "",
      "responses": "0",
      "limit": "100",
      "distributed": "false"
    },
    {
      "id": "321",
      "name": "Male Quota",
      "description": "",
      "responses": "0",
      "limit": "100",
      "distributed": "false"
    }
  ]
}

Get SurveyQuotas Return Example (.json format):

{
  "result_ok": true,
  "id": "123",
  "name": "Female Quota",
  "description": "",
  "limit": "100",
  "responses": "0",
  "distributed": "false",
  "groups": [
    {
      "id": "123abc456",
      "rules": [
        {
          "id": "654cba321",
          "input_value": "5",
          "operator": "12",
          "answers_type": "17",
          "answers_values": [
            "5-10002"
          ]
        }
      ]
    }
  ]
}

Create SurveyQuotas Return Example (.json format):

{
  "result_ok": true,
  "id": "123",
  "name": "Demo Quota",
  "description": "",
  "limit": "100",
  "responses": "0",
  "distributed": "false",
  "groups": [
    {
      "id": "123abc456",
      "rules": [
        {
          "id": "654cba321",
          "input_value": "5",
          "operator": "12",
          "answers_type": "17",
          "answers_values": [
            "5-10002"
          ]
        }
      ]
    }
  ]
}

Update SurveyQuotas Return Example (.json format):

{
  "result_ok": true,
  "id": "123",
  "name": "Demo Quota 2",
  "description": "",
  "limit": "111",
  "responses": "0",
  "distributed": "false",
  "groups": [
    {
      "id": "123abc456",
      "rules": [
        {
          "id": "654cba321",
          "input_value": "5",
          "operator": "12",
          "answers_type": "17",
          "answers_values": [
            "5-10002"
          ]
        }
      ]
    }
  ]
}

Delete SurveyQuotas Return Example (.json format):

{
  "0": true,
  "result_ok": true
}