Wiki labels/machine paths

From Meta, a Wikimedia project coordination wiki
Jump to navigation Jump to search
Other languages:
English • ‎español • ‎français • ‎magyar • ‎português • ‎українська

Machine-readable paths

/campaigns/ - Lists wikis with available campaigns.


/campaigns/<wiki>/ - Lists out campaigns available for a wiki
  • Add ?campaign=stats to the query string to include statistics about a campaign in the response.


/campaigns/<wiki>/<campaign_id>/ - Returns data about a campaign.
  • Add ?tasks to the query string to include the campaign's tasks in the response
  • Add ?worksets to the query string to include the worksets for the campaign in the response. Specify ?worksets=stats to include completion statistics with the workset listings.
  • Add ?assign to the query string to request a new workset assignment for the current user. This will only work if (1) the user is logged in, (2) there's tasks available to be assigned and (3) the user doesn't already have an open workset assignment.
/campaigns/<wiki>/<campaign_id>/<workset_id>/ - Returns data about a workset
  • Add ?tasks to the query string to list out the tasks for this workset.
  • Add ?worksets=stats to include completion statistics with the workset listing.
  • Add ?campaign to the query string to include relevant campaign data and ?campaign=stats to also include campaign statistics.
  • Add ?abandon to the query string to release the incomplete tasks from this workset. This will only work if (1) the user is logged in and (2) the workset in question is assigned to the user. Only incomplete tasks will be released from the workset.
/campaigns/<wiki>/<campaign_id>/<workset_id>/<task_id>/ - Returns data about a particular task.
  • Add ?campaign to the query string to include relevant campaign data and ?campaign=stats to also include campaign statistics.
  • Add ?worksets to the query string to include relevant worksets' data and ?worksets=stats to also include workset statistics.
  • Add ?label=<encoded json> to the URL. E.g. campaigns/enwiki/1/1/1?label={"damaging":true,"good-faith":false}. This will only work if the user is logged in.
/users/ - Provides access to data from the point of view of a user


/users/<user_id>/ - Returns information about a user's activities
  • Add ?campaigns to the query string to return all campaigns that the user has been assigned worksets for. Specify ?campaigns=stats to also include campaign statistics.
  • Add ?worksets to the query string to return all worksets assigned to the user. Specify ?worksets=stats to also include workset statistics.
  • Add ?tasks to the query string to return all tasks assigned to the user. Note that labels applied by other users will be hidden from this view.
/users/<user_id>/<campaign_id>/ - Returns information about a user's activities within a campaign
  • Add ?campaigns=stats to the query string to include campaign statistics.
  • Add ?worksets to the query string to return all worksets assigned to the user. Specify ?worksets=stats to also include workset statistics.
  • Add ?tasks to the query string to return all tasks assigned to the user. Note that labels applied by other users will be hidden from this view.
/auth/ - Provides support for authentication of users.


/auth/initiate/ - Starts an OAuth handshake with MediaWiki.

It is recommended that this path is requested from a pop-up window.

/auth/callback/ - Used by MediaWiki to complete an OAuth handshake.

When a pop-up window is redirected here, it will be automatically closed.

/auth/whoami/ - Prints information about logged-in user

...

/auth/logout/ - Deletes session and forgets about user

...

/forms/ - Provides access to form configuration and internationalization

These forms can be loaded by the labels gadget.


/forms/<form_name> - Returns the form configuration

...