95e6f3d3ab
* add 3.1 to deprecated versions * rewrite img src to use azure blob storage in archive script Co-authored-by: rachmari <rachmari@users.noreply.github.com> * remove static files for ghes 3.1 * remove liquid conditionals and content for ghes 3.1 * remove outdated hardware reqs reusable * Fix liquid conditional uncaught by script * Close liquid conditionals missed by script * Apply @mattpollard's suggestions Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: rachmari <rachmari@users.noreply.github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
38 lines
1.5 KiB
Markdown
38 lines
1.5 KiB
Markdown
---
|
|
title: Repository statistics
|
|
shortTitle: Statistics
|
|
allowTitleToDifferFromFilename: true
|
|
intro: 'The Repository statistics API allows you to fetch the data that {% data variables.product.product_name %} uses for visualizing different types of repository activity.'
|
|
versions:
|
|
fpt: '*'
|
|
ghes: '*'
|
|
ghae: '*'
|
|
ghec: '*'
|
|
topics:
|
|
- API
|
|
miniTocMaxHeadingLevel: 3
|
|
---
|
|
|
|
## About the Repository statistics API
|
|
|
|
The Repository statistics API allows you to fetch the data that {% data variables.product.product_name %} uses for visualizing different types of repository activity.
|
|
|
|
### A word about caching
|
|
|
|
Computing repository statistics is an expensive operation, so we try to return cached
|
|
data whenever possible. If the data hasn't been cached when you query a repository's
|
|
statistics, you'll receive a `202` response; a background job is also fired to
|
|
start compiling these statistics. Give the job a few moments to complete, and
|
|
then submit the request again. If the job has completed, that request will receive a
|
|
`200` response with the statistics in the response body.
|
|
|
|
Repository statistics are cached by the SHA of the repository's default branch; pushing to the default branch resets the statistics cache.
|
|
|
|
### Statistics exclude some types of commits
|
|
|
|
The statistics exposed by the API match the statistics shown by [different repository graphs](/github/visualizing-repository-data-with-graphs/about-repository-graphs).
|
|
|
|
To summarize:
|
|
- All statistics exclude merge commits.
|
|
- Contributor statistics also exclude empty commits.
|