Reports - lampholder/spudbin GitHub Wiki
Some general points on how to use the report-generation features (UX and API):
- The usernames parameter accepts a comma-separated list of github usernames
- All dates are in YYYY-mm-dd format
GET https://<domain>/<mount>/api/reports/whoHasTokenized?usernames=<username>[,<username>...]&start=YYYY-mm-dd&end=YYYY-mm-dd
GET https://<domain>/<mount>/whoHasTokenized?usernames=<username>[,<username>...]&start=YYYY-mm-dd&end=YYYY-mm-dd
The time-spent reports include some features to help with usefully slicing the data:
- The timeWindow parameter accepts
week
,month
, orperiod
:-
week
divides the data on calendar week -
month
divites the data on calendar month -
period
returns the full aggregated dataset for the period specified (unsliced)
-
- The groupBy parameter accepts
tag
orbucket
:-
tag
groups the results by tag. Since buckets can have multiple tags, slicing by tags can produce confusing results if the tags are not also filtered to a subset of orthogonal tags (i.e. if you tokenise in a bucket tagged as both 'maintenance' and 'Project Zappa', your generated report will count that token twice. It is recommended that the groupBy tag feature is used in conjunction with filtering othogonal tags (e.g. filter to tags representing task type, or product name, but not both). -
bucket
groups the results by bucket. Has none of the complexity of filtering by tag.
-
- The tags parameter is optional - if you specify (a comma-separated list of) tags, only tokens allocated to buckets tagged with those tags will be counted
- The stacked parameter is optional - if you specify
stacked=percent
the graph will render percentage-of-total-tokens-submitted rather than literal-number-of-tokens-submitted.
GET https://<domain>/<mount>/api/reports?usernames=<username>[,<username>...]&start=YYYY-mm-dd&end=YYYY-mm-dd&groupBy=[tag/bucket]&timeWindow=[week/month/period][&tags=<tag>[,<tag>...]]
GET https://<domain>/<mount>/graph?usernames=<username>[,<username>...]&start=YYYY-mm-dd&end=YYYY-mm-dd&groupBy=[tag/bucket]&timeWindow=[week/month/period][&tags=<tag>[,<tag>...]][&stacked=percent]