Skip to content

Latest commit

 

History

History
120 lines (75 loc) · 3.85 KB

page.rst

File metadata and controls

120 lines (75 loc) · 3.85 KB
Raw

Page API

API endpoints related to a single page.

Article info

The pageviews and edits data REST APIs.

GET /api/page/articleinfo/{project}/{article}/{format}

Get basic information about the history of a page.

Parameters:

  • project (required) - Project domain or database name.
  • article (required) - Full page title.

Example:

Get basic information about Albert Einstein.

https://xtools.wmflabs.org/api/page/articleinfo/en.wikipedia.org/Albert_Einstein

Prose

GET /api/page/prose/{project}/{article}

Get statistics about the prose (characters, word count, etc.) and referencing of a page.

Parameters:

  • project (required) - Project domain or database name.
  • article (required) - Full page title.

Example:

Get prose statistics of Albert Einstein.

https://xtools.wmflabs.org/api/page/prose/en.wikipedia.org/Albert_Einstein

Links

GET /api/page/links/{project}/{article}

Get the number of in and outgoing links and redirects to the given page.

Parameters:

  • project (required) - Project domain or database name.
  • article (required) - Full page title.

Example:

Get links statistics of Albert Einstein.

https://xtools.wmflabs.org/api/page/links/en.wikipedia.org/Albert_Einstein

Top editors

GET /api/page/top_editors/{project}/{article}/{start}/{end}/{limit}

Get the top editors to a page by edit count. You can optionally pass in ?nobots=1 to exclude bots from the results.

Parameters:

  • project (required) - Project domain or database name.
  • article (required) - Full page title.
  • start - Start date in the format YYYY-MM-DD.
  • end - End date in the format YYYY-MM-DD.
  • limit - Number of results to return. Default 20, maximum 1000.

Example:

Get the top editors to the English Wikipedia article Albert Einstein.

https://xtools.wmflabs.org/api/page/top_editors/en.wikipedia/Albert_Einstein

Same as above, but return 50 results.

https://xtools.wmflabs.org/api/page/top_editors/en.wikipedia/Albert_Einstein///50

Get the top 50 editors in 2017 to the English Wikipedia article Albert Einstein., excluding bots.

https://xtools.wmflabs.org/api/page/top_editors/en.wikipedia/Albert_Einstein/2017-01-01/2017-12-31/50?nobots=1

Assessments

GET /api/page/assessments/{project}/{articles}

Get assessment data of the given articles, including the overall quality classifications, along with a list of the WikiProjects and their classifications and importance levels. You can optionally pass in ?classonly=1 to get only the overall quality assessment.

Parameters:

  • project (required) - Project domain or database name.
  • article (required) - One or more full page titles, separated by pipes |

Example:

Get the assessment data on the English Wikipedia articles Albert Einstein and Bob Dylan.

https://xtools.wmflabs.org/api/page/assessments/enwiki/Albert_Einstein|Bob_Dylan https://xtools.wmflabs.org/api/page/assessments/en.wikipedia/Albert_Einstein|Bob_Dylan https://xtools.wmflabs.org/api/page/assessments/en.wikipedia.org/Albert_Einstein|Bob_Dylan

Same as above, but get only the overall quality assessments.

https://xtools.wmflabs.org/api/page/assessments/en.wikipedia.org/Albert_Einstein|Bob_Dylan?classonly=1