GET api/surveys/questions/{question}/statistics

Gives you the statistics of a given survey question

Request Information

URI Parameters

NameDescriptionTypeAdditional information
question

Question ID

integer

Required

Body Parameters

None.

Response Information

Resource Description

Statistics summary of question

SurveyQuestionStatisticsDTO
NameDescriptionTypeAdditional information
AlternativeAnswers

Statistics for each alternative answer, if any

Collection of SurveyQuestionStatisticsAlternativeDTO

None.

TextAnswers

Statistics for each text answer, if any

Collection of SurveyQuestionStatisticsTextDTO

None.

NumericalAnswers

Statistics for each numerical/slider answer, if any

Collection of SurveyQuestionStatisticsNumericalDTO

None.

Comments

Number of comments on question

integer

None.

Survey

ID of parent Survey

integer

None.

ID

Question ID

integer

Required

Question

Question title/text

string

Required

String length: inclusive between 0 and 250

HelpText

Question help text

string

String length: inclusive between 0 and 500

Type

Question type

QuestionType

Required

Range: inclusive between 0 and 6

Required

Whether the question is mandatory

boolean

Required

Commentable

Whether a comment can be left along with the answer

boolean

Required

Order

Question order index in survey

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "AlternativeAnswers": [
    {
      "Answers": 1,
      "Question": 2,
      "ID": 3,
      "Name": "sample string 4",
      "Order": 1,
      "AlarmTrigger": true
    },
    {
      "Answers": 1,
      "Question": 2,
      "ID": 3,
      "Name": "sample string 4",
      "Order": 1,
      "AlarmTrigger": true
    }
  ],
  "TextAnswers": [
    {
      "Text": "sample string 1",
      "Answers": 2
    },
    {
      "Text": "sample string 1",
      "Answers": 2
    }
  ],
  "NumericalAnswers": [
    {
      "Value": 1.0,
      "Answers": 2
    },
    {
      "Value": 1.0,
      "Answers": 2
    }
  ],
  "Comments": 1,
  "Survey": 1,
  "ID": 2,
  "Question": "sample string 3",
  "HelpText": "sample string 4",
  "Type": 0,
  "Required": true,
  "Commentable": true,
  "Order": 1
}