wx_query_api: Generate a rate-limited Analytics Query Service API caller
In bearloga/waxer: API Client Library for 'Wikimedia Analytics Query Service (AQS)'

Description Usage Arguments Value License

Generates a function which makes a request to wikimedia.org/api/rest_v1/. This generator is primarily intended for internal use, but can theoretically be used by others to write custom Wikimedia REST API queries.

1	wx_query_api(reqs_per_second = 200)

reqs_per_second

maximum requests allowed per second (default 200)

A rate-limited function with parameters:

path: path after endpoint; e.g. /registered-users/new/{project}/{granularity}/{start}/{end}
endpoint: /metrics by default but can be changed to /feed (for example)

The generated function, when run, processed the JSON response and returns a list. It is up to the user of this generator to turn the results into a data frame or another object.

Data retrieved from the API endpoint is available under the CC0 1.0 license.

bearloga/waxer documentation built on Nov. 28, 2020, 11:28 p.m.