Statistics

Generate report based on provided query parameters.

get/api/v1/statistics

Request

  • Base URL: https://demo.mysurvey.solutions (the document declares no server; this is the origin it was published from)
  • URL: https://demo.mysurvey.solutions/api/v1/statistics
  • Auth: HTTP basic and HTTP bearer

Query parameters

QuestionnaireIdstring required

Questionnaire Id

Versioninteger

Questionnaire version

Questionstring required

Question variable name or UUID

Mininteger

Minimum value of answers to count in report

Maxinteger

Maximum value of answers to count in report

exportType'Excel' | 'Csv' | 'Tab'

Specify report format to ouput

ConditionalQuestionstring

Condition question variable name or UUID

condition[]integer[]

List of condition question answers to filter on

Pivotboolean

Specify true if Pivot Table output needed.

ExpandTeamsboolean

Show detailed report with team members for each team

statuses[]string[]

List of statuses to apply filtering

Drawinteger

Datatables specific

Startinteger

Paging - Start row

Lengthinteger

How many rows per page

Columninteger
Dir'Asc' | 'Desc'
Namestring nullable

order of output

Titleinteger
Namestring nullable
Searchableboolean
Orderableboolean

This is shorthand for Columns property. DataTable works via Get requests

Titleinteger
Namestring nullable
Searchableboolean
Orderableboolean

List of columns that need to be outputed. Leave null for default values

Titleinteger
Namestring nullable
Searchableboolean
Orderableboolean
Search.Valuestring
Search.Regexboolean
PageIndexinteger
PageSizeinteger

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.