module MediaWiktory::Wikipedia::Modules::Pageviews

Shows per-page pageview data (the number of daily pageviews for each of the last pvipdays days). The result format is page title (with underscores) => date (Ymd) => count.

The “submodule” (MediaWiki API term) is included in action after setting some param, providing additional tweaking for this param. Example (for {MediaWiktory::Wikipedia::Actions::Query} and its submodules):

“`ruby api.query # returns Actions::Query

.prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
.limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL

“`

All submodule's parameters are documented as its public methods, see below.

Public Instance Methods

_metric(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/pageviews.rb, line 30
def _metric(value)
  defined?(super) && super || ["pageviews"].include?(value.to_s) && merge(pvipmetric: value.to_s)
end
continue(value) click to toggle source

When more results are available, use this to continue.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/pageviews.rb, line 46
def continue(value)
  merge(pvipcontinue: value.to_s)
end
days(value) click to toggle source

The number of days to show.

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/modules/pageviews.rb, line 38
def days(value)
  merge(pvipdays: value.to_s)
end
metric(value) click to toggle source

The metric to use for counting views. Depending on what backend is used, not all metrics might be supported. You can use the siteinfo API (action=query&meta=siteinfo) to check, under pageviewservice-supported-metrics / <module name>

@param value [String] One of “pageviews” (Plain pageviews). @return [self]

# File lib/mediawiktory/wikipedia/modules/pageviews.rb, line 25
def metric(value)
  _metric(value) or fail ArgumentError, "Unknown value for metric: #{value}"
end