### Home Classes Methods

### In Files

- lib/github_api/repos/statistics.rb

### Parent

API

### Methods

- #code_frequency
- #commit_activity
- #contributors
- #participation
- #punch_card

### Class/Module Index

Quicksearch

- Github
- Github::API
- Github::Activity
- Github::Activity::Events
- Github::Activity::Notifications
- Github::Activity::Starring
- Github::Activity::Watching
- Github::ApiFactory
- Github::Arguments
- Github::Authorization
- Github::Authorizations
- Github::AutoloadHelper
- Github::Client
- Github::Configuration
- Github::Connection
- Github::Constants
- Github::CoreExt
- Github::CoreExt::OrderedHash
- Github::Descendants
- Github::Emojis
- Github::Error
- Github::Error::BadRequest
- Github::Error::ClientError
- Github::Error::Forbidden
- Github::Error::GithubError
- Github::Error::InternalServerError
- Github::Error::InvalidOptions
- Github::Error::NotAcceptable
- Github::Error::NotFound
- Github::Error::RequiredParams
- Github::Error::ServiceError
- Github::Error::ServiceUnavailable
- Github::Error::Unauthorized
- Github::Error::UnknownValue
- Github::Error::UnprocessableEntity
- Github::Error::Validations
- Github::Gists
- Github::Gists::Comments
- Github::GitData
- Github::GitData::Blobs
- Github::GitData::Commits
- Github::GitData::References
- Github::GitData::Tags
- Github::GitData::Trees
- Github::Gitignore
- Github::Issues
- Github::Issues::Assignees
- Github::Issues::Comments
- Github::Issues::Events
- Github::Issues::Labels
- Github::Issues::Milestones
- Github::Jsonable
- Github::Markdown
- Github::Meta
- Github::MimeType
- Github::Normalizer
- Github::Orgs
- Github::Orgs::Members
- Github::Orgs::Teams
- Github::PageIterator
- Github::PageLinks
- Github::PagedRequest
- Github::Pagination
- Github::ParameterFilter
- Github::ParamsHash
- Github::PullRequests
- Github::PullRequests::Comments
- Github::RateLimit
- Github::Repos
- Github::Repos::Collaborators
- Github::Repos::Comments
- Github::Repos::Commits
- Github::Repos::Contents
- Github::Repos::Downloads
- Github::Repos::Forks
- Github::Repos::Hooks
- Github::Repos::Keys
- Github::Repos::Merging
- Github::Repos::PubSubHubbub
- Github::Repos::Statistics
- Github::Repos::Statuses
- Github::Request
- Github::Request::BasicAuth
- Github::Request::Jsonize
- Github::Request::OAuth2
- Github::Resource
- Github::Response
- Github::Response::Header
- Github::Response::Jsonize
- Github::Response::Mashify
- Github::Response::RaiseError
- Github::Response::Xmlize
- Github::ResponseWrapper
- Github::S3Uploader
- Github::Say
- Github::Scopes
- Github::Search
- Github::Users
- Github::Users::Emails
- Github::Users::Followers
- Github::Users::Keys
- Github::Utils
- Github::Utils::Url
- Github::VERSION
- Github::Validations
- Github::Validations::Format
- Github::Validations::Presence
- Github::Validations::Required
- Github::Validations::Token
- Hash

No matching classes.

# Github::Repos::Statistics

The Repository Statistics API allows you to fetch the data that GitHub uses for visualizing different types of repository activity.

### Public Instance Methods

code_frequency(*args) click to toggle source

Get the number of additions and deletions per week

# Examples

    github = Github.new
    github.repos.stats.code_frequency user: '...', repo: '...'
    github.repos.stats.code_frequency user: '...', repo: '...' { |stat| ... }

    # File lib/github_api/repos/statistics.rb, line 53
    def code_frequency(*args)
      arguments(args, :required => [:user, :repo])
      params = arguments.params

      get_request("/repos/#{user}/#{repo}/stats/code_frequency", params)
    end

commit_activity(*args) click to toggle source

Get the last year of commit activity data

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

# Examples

    github = Github.new
    github.repos.stats.commit_activity user: '...', repo: '...'
    github.repos.stats.commit_activity user: '...', repo: '...' { |stat| ... }

    # File lib/github_api/repos/statistics.rb, line 36
    def commit_activity(*args)
      arguments(args, :required => [:user, :repo])
      params = arguments.params

      response = get_request("/repos/#{user}/#{repo}/stats/commit_activity", params)
      return response unless block_given?
      response.each { |el| yield el }
    end

contributors(*args) click to toggle source

Get contributors list with additions, deletions, and commit counts

# Examples

    github = Github.new
    github.repos.stats.contributors user: '...', repo: '...'
    github.repos.stats.contributors user: '...', repo: '...' { |stat| ... }

    # File lib/github_api/repos/statistics.rb, line 16
    def contributors(*args)
      arguments(args, :required => [:user, :repo])
      params = arguments.params

      response = get_request("/repos/#{user}/#{repo}/stats/contributors", params)
      return response unless block_given?
      response.each { |el| yield el }
    end

participation(*args) click to toggle source

Get the weekly commit count for the repo owner and everyone else

# Examples

    github = Github.new
    github.repos.stats.participation user: '...', repo: '...'
    github.repos.stats.participation user: '...', repo: '...' { |stat| ... }

    # File lib/github_api/repos/statistics.rb, line 68
    def participation(*args)
      arguments(args, :required => [:user, :repo])
      params = arguments.params

      get_request("/repos/#{user}/#{repo}/stats/participation", params)
    end

punch_card(*args) click to toggle source

Get the number of commits per hour in each day

# Examples

    github = Github.new
    github.repos.stats.punch_card user: '...', repo: '...'
    github.repos.stats.punch_card user: '...', repo: '...' { |stat| ... }

    # File lib/github_api/repos/statistics.rb, line 83
    def punch_card(*args)
      arguments(args, :required => [:user, :repo])
      params = arguments.params

      response = get_request("/repos/#{user}/#{repo}/stats/punch_card", params)
      return response unless block_given?
      response.each { |el| yield el }
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.