Metrics

The repository metrics API allows you to retrieve community profile, statistics, and traffic for your repository.

Statistics

The Repository Statistics API allows you to fetch the data that GitHub Enterprise Server 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.

To summarize:

All statistics exclude merge commits.

Contributor statistics also exclude empty commits.

Get the weekly commit activity

Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

get /repos/{owner}/{repo}/stats/code_frequency

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.
`owner`	string	path
`repo`	string	path

Code samples

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/code_frequency

JavaScript (@octokit/core.js)

await octokit.request('GET /repos/{owner}/{repo}/stats/code_frequency', {
  owner: 'octocat',
  repo: 'hello-world'
})

Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

Status: 200 OK

[
  [
    1302998400,
    1124,
    -435
  ]
]

Accepted

Status: 202 Accepted

A header with no content is returned.

Status: 204 No Content

Notes

Works with GitHub Apps

Get the last year of commit activity

Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.

get /repos/{owner}/{repo}/stats/commit_activity

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.
`owner`	string	path
`repo`	string	path

Code samples

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/commit_activity

JavaScript (@octokit/core.js)

await octokit.request('GET /repos/{owner}/{repo}/stats/commit_activity', {
  owner: 'octocat',
  repo: 'hello-world'
})

Response

Status: 200 OK

[
  {
    "days": [
      0,
      3,
      26,
      20,
      39,
      1,
      0
    ],
    "total": 89,
    "week": 1336280400
  }
]

Accepted

Status: 202 Accepted

A header with no content is returned.

Status: 204 No Content

Notes

Works with GitHub Apps

Get all contributor commit activity

Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:

w - Start of the week, given as a Unix timestamp.
a - Number of additions
d - Number of deletions
c - Number of commits

get /repos/{owner}/{repo}/stats/contributors

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.
`owner`	string	path
`repo`	string	path

Code samples

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/contributors

JavaScript (@octokit/core.js)

await octokit.request('GET /repos/{owner}/{repo}/stats/contributors', {
  owner: 'octocat',
  repo: 'hello-world'
})

`w` - Start of the week, given as a Unix timestamp.

`a` - Number of additions

`d` - Number of deletions

`c` - Number of commits

Status: 200 OK

[
  {
    "author": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "total": 135,
    "weeks": [
      {
        "w": 1367712000,
        "a": 6898,
        "d": 77,
        "c": 10
      }
    ]
  }
]

Accepted

Status: 202 Accepted

A header with no content is returned.

Status: 204 No Content

Notes

Works with GitHub Apps

Get the weekly commit count

Returns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.

The array order is oldest week (index 0) to most recent week.

get /repos/{owner}/{repo}/stats/participation

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.
`owner`	string	path
`repo`	string	path

Code samples

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/participation

JavaScript (@octokit/core.js)

await octokit.request('GET /repos/{owner}/{repo}/stats/participation', {
  owner: 'octocat',
  repo: 'hello-world'
})

The array order is oldest week (index 0) to most recent week.

Status: 200 OK

Resource not found

Status: 404 Not Found

Notes

Works with GitHub Apps

Get the hourly commit count for each day

Each array contains the day number, hour number, and number of commits:

0-6: Sunday - Saturday
0-23: Hour of day
Number of commits

For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

get /repos/{owner}/{repo}/stats/punch_card

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to `application/vnd.github.v3+json` is recommended.
`owner`	string	path
`repo`	string	path

Code samples

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/repos/octocat/hello-world/stats/punch_card

JavaScript (@octokit/core.js)

await octokit.request('GET /repos/{owner}/{repo}/stats/punch_card', {
  owner: 'octocat',
  repo: 'hello-world'
})

For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

Status: 200 OK

A header with no content is returned.

Status: 204 No Content

Notes

Works with GitHub Apps

Metrics

Statistics

A word about caching

Statistics exclude some types of commits

Get the weekly commit activity

Shell

JavaScript (@octokit/core.js)

Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

Accepted

A header with no content is returned.

Notes

Get the last year of commit activity

Shell

JavaScript (@octokit/core.js)

Response

Accepted

A header with no content is returned.

Notes

Get all contributor commit activity

Shell

JavaScript (@octokit/core.js)

w - Start of the week, given as a Unix timestamp. a - Number of additions d - Number of deletions c - Number of commits

Accepted

A header with no content is returned.

Notes

Get the weekly commit count

Shell

JavaScript (@octokit/core.js)

The array order is oldest week (index 0) to most recent week.

Resource not found

Notes

Get the hourly commit count for each day

Shell

JavaScript (@octokit/core.js)

For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

A header with no content is returned.

Notes

`w` - Start of the week, given as a Unix timestamp.

`a` - Number of additions

`d` - Number of deletions

`c` - Number of commits

For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.