Module: Octokit::Client::Traffic

Included in:
Octokit::Client
Defined in:
lib/octokit/client/traffic.rb

Overview

Methods for the Traffic API

Instance Method Summary collapse

Instance Method Details

#clones(repo, options = {}) ⇒ Sawyer::Resource

Get the total number of clones and breakdown per day or week for the last 14 days

Examples:

Clones per day

@client.clones('octokit/octokit.rb')

Clones per week

@client.clones('octokit/octokit.rb', per: 'week')

Parameters:

  • repo (Integer, String, Repository, Hash)

    A GitHub Repository

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :per (String) — default: 'day'

    Views per. day or week

Returns:

  • (Sawyer::Resource)

    Breakdown of clone stats

See Also:


62
63
64
65
# File 'lib/octokit/client/traffic.rb', line 62

def clones(repo, options = {})
  opts = ensure_api_media_type(:traffic, options)
  get "#{Repository.path repo}/traffic/clones", opts
end

#top_paths(repo, options = {}) ⇒ Array<Sawyer::Resource>

Get the top 10 popular contents over the last 14 days

Examples:

@client.top_paths('octokit/octokit.rb')

Parameters:

  • repo (Integer, String, Repository, Hash)

    A GitHub repository

Returns:

  • (Array<Sawyer::Resource>)

    List of popular contents

See Also:


28
29
30
31
# File 'lib/octokit/client/traffic.rb', line 28

def top_paths(repo, options = {})
  opts = ensure_api_media_type(:traffic, options)
  get "#{Repository.path repo}/traffic/popular/paths", opts
end

#top_referrers(repo, options = {}) ⇒ Array<Sawyer::Resource>

Get the top 10 referrers over the last 14 days

Examples:

@client.top_referrers('octokit/octokit.rb')

Parameters:

  • repo (Integer, String, Repository, Hash)

    A GitHub repository

Returns:

  • (Array<Sawyer::Resource>)

    List of referrers and stats

See Also:


16
17
18
19
# File 'lib/octokit/client/traffic.rb', line 16

def top_referrers(repo, options = {})
  opts = ensure_api_media_type(:traffic, options)
  get "#{Repository.path repo}/traffic/popular/referrers", opts
end

#views(repo, options = {}) ⇒ Sawyer::Resource

Get the total number of views and breakdown per day or week for the last 14 days

Examples:

Views per day

@client.views('octokit/octokit.rb')

Views per week

@client.views('octokit/octokit.rb', per: 'week')

Parameters:

  • repo (Integer, String, Repository, Hash)

    A GitHub Repository

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :per (String) — default: 'day'

    Views per. day or week

Returns:

  • (Sawyer::Resource)

    Breakdown of view stats

See Also:


45
46
47
48
# File 'lib/octokit/client/traffic.rb', line 45

def views(repo, options = {})
  opts = ensure_api_media_type(:traffic, options)
  get "#{Repository.path repo}/traffic/views", opts
end