Métricas

Estatísticas

A API de Estatísticas do Repositório permite que você recupere os dados que o GitHub Enterprise Server usa para visualizar diferentes tipos de atividade do repositório.

Umas palavras sobre o armazenamento em cache

Computar as estatísticas do repositório é uma operação cara. Por esse motivo, tentamos retornar dados armazenados em cache sempre que possível. Se os dados não forem armazenados em cache nas estatísticas de um repositório, você receberá uma resposta de 202; um trabalho em segundo plano também é acionado para começar a compilar estas estatísticas. Dê ao trabalho alguns instantes para que seja concluído e, em seguida, envie a solicitação novamente. Se o trabalho foi concluído, essa solicitação receberá uma resposta de 200 com as estatísticas no texto da resposta.

As estatísticas do repositório são armazenadas em cache pelo SHA do branch-padrão do repositório; fazer push para o branch-padrão redefine o armazenamento em cache de estatísticas.

As estatísticas excluem alguns tipos de commits

As estatísticas expostas pela API correspondem � s estatísticas mostradas pelos diferentes gráficos de repositórios.

Resumo:

• Todas as estatísticas excluem commits de merge.

• As estatísticas do contribuidor também excluem commits vazios.

  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

  Parâmetros

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

  Amostras de código

  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

  Parâmetros

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

  Amostras de código

  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

  Parâmetros

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

  Amostras de código

  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

  Parâmetros

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

  Amostras de código

  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

  {
    "all": [
      11,
      21,
      15,
      2,
      8,
      1,
      8,
      23,
      17,
      21,
      11,
      10,
      33,
      91,
      38,
      34,
      22,
      23,
      32,
      3,
      43,
      87,
      71,
      18,
      13,
      5,
      13,
      16,
      66,
      27,
      12,
      45,
      110,
      117,
      13,
      8,
      18,
      9,
      19,
      26,
      39,
      12,
      20,
      31,
      46,
      91,
      45,
      10,
      24,
      9,
      29,
      7
    ],
    "owner": [
      3,
      2,
      3,
      0,
      2,
      0,
      5,
      14,
      7,
      9,
      1,
      5,
      0,
      48,
      19,
      2,
      0,
      1,
      10,
      2,
      23,
      40,
      35,
      8,
      8,
      2,
      10,
      6,
      30,
      0,
      2,
      9,
      53,
      104,
      3,
      3,
      10,
      4,
      7,
      11,
      21,
      4,
      4,
      22,
      26,
      63,
      11,
      2,
      14,
      1,
      10,
      3
    ]
  }
  

  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

  Parâmetros

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

  Amostras de código

  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

  [
    [
      0,
      0,
      5
    ],
    [
      0,
      1,
      43
    ],
    [
      0,
      2,
      21
    ]
  ]
  

  A header with no content is returned.

  Status: 204 No Content

  Notes

  • Works with GitHub Apps