Get analytics
The numbers on the Auditor page's Analytics tab, for the team or one repository, as JSON or as CSV.
Query
- periodstringoptional
7d,30d(default) or90d, ending now. - repositorystringoptional
Only this repository, as
owner/name. It must be one Auditor reviews. - formatstringoptional
json(default) orcsv. - tablestringoptional
With
format=csv, which table:repositories(default),authors,kinds,timelineorsummary. The columns are the JSON's field names.
Response
- summaryobjectrequired
The period's totals.
acted_on_percentis the share of decided findings that led to a change (null when none were decided);findings_opencounts what is open now, whenever it was posted;median_seconds_to_mergeruns from a pull request's first review to its merge. - timelinearrayrequired
Findings posted in each day (
7d) or week, by how they ended, and findings resolved in it.startis the day it begins, in UTC. - repositories, authorsarrayrequired
One row per repository, and per pull request author (up to 50): pull requests reviewed, reviews started automatically or asked for, findings posted, resolved and open, commands and previews. Repositories carry cost.
- kindsarrayrequired
Each kind of finding by how often it is acted on.
statusisposted,low(rarely acted on) ormutedby tuning. - spend, endingsarrayrequired
Cost by what spent it, and decided findings by how they ended.
Notes
- Keyoptional
Needs a key with Auditor Permissions: the answer names people and costs. Any other key gets
403 policy_denied. - CSVoptional
Answered as
text/csvwith a file name. A cell that starts with=,+,-or@is prefixed with an apostrophe so a spreadsheet never runs it as a formula.