MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

list=surveys (su)

(main | query | surveys)

API module for obtaining surveys and optionally their questions.

Specific parameters:
Other general parameters are available.
suids

The IDs of the surveys to return.

Type: list of integers
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients that are allowed higher limits).
sunames

The names of the surveys to return.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients that are allowed higher limits).
suprops

Survey data to query.

Values (separate with | or alternative): *, enabled, expiry, footer, header, id, min_pages, name, namespaces, ratio, thanks, title, user_type
Default: id|name|enabled
suincquestions

Include the questions of the surveys or not.

Type: integer
Default: 0
suenabled

Enabled state to filter on.

Type: integer
sulimit

Max amount of words to return.

Type: integer or max
The value must be between 1 and 500.
Default: 20
sucontinue

Offset number from where to continue the query.