GET api/surveys/{survey}/statistics

Gives you the statistics of a given survey

Request Information

URI Parameters

NameDescriptionTypeAdditional information
survey

Survey ID

integer

Required

Body Parameters

None.

Response Information

Resource Description

Statistics summary of survey

SurveyStatisticsDTO
NameDescriptionTypeAdditional information
Questions

Number of questions in the survey

integer

None.

Recipients

Number of recipients of the survey

integer

None.

Opened

Number of recipients of the survey who has opened it

integer

None.

OpenedPercentage

Portion of recipients of the survey who has opened it

decimal number

None.

Unfinished

Number of recipents of the survey who has opened it but not yet answered it

integer

None.

UnfinishedPercentage

Portion of recipents of the survey who has opened it but not yet answered it

decimal number

None.

Answered

Number of recipients of the survey who has answered it

integer

None.

AnsweredPercentage

Portion of recipients of the survey who has answered it

decimal number

None.

ID

Survey ID

integer

None.

Keyword

Survey keyword

string

Matching regular expression pattern: ^\S+$

String length: inclusive between 0 and 15

Created

Timestamp for survey creation

date

None.

Modified

Timestamp for last modification of survey

date

None.

Ended

Whether the survey has ended or is closed

boolean

None.

Name

Survey name

string

Required

String length: inclusive between 0 and 150

Ends

Timestamp for survey end, or null if not set

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Questions": 1,
  "Recipients": 2,
  "Opened": 3,
  "OpenedPercentage": 150.0,
  "Unfinished": 4,
  "UnfinishedPercentage": 133.33,
  "Answered": 5,
  "AnsweredPercentage": 250.0,
  "ID": 6,
  "Keyword": "sample string 7",
  "Created": "2019-08-19T15:32:41.2791357+00:00",
  "Modified": "2019-08-19T15:32:41.2791357+00:00",
  "Ended": true,
  "Name": "sample string 9",
  "Ends": "2019-08-19T15:32:41.2791357+00:00"
}