Contents

module Bugsnag
  module Api
    class Client

      # Methods for the Pivots API
      #
      # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/pivots
      module Pivots
        # List Pivots on an Error
        #
        # @option filters [Object] An optional filter object, see http://docs.bugsnagapiv2.apiary.io/#introduction/filtering
        # @option summary_size [Number] The number of elements to include in the list
        # @option pivots [Array] EventField display_ids to identify pivots to return
        # @option per_page [Number] Number of results to be returned per page
        # @return [Array<Sawyer::Resource>] List of Pivots for the Error specified
        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/pivots/list-pivots-on-an-error
        def pivots(project_id, error_id=nil, options = {})
          if error_id.nil?
            get "projects/#{project_id}/pivots", options
          else
            paginate "projects/#{project_id}/errors/#{error_id}/pivots", options
          end
        end

        # List values of a Pivot on an Error
        #
        # @option filters [Object] An optional filter object, see http://docs.bugsnagapiv2.apiary.io/#introduction/filtering
        # @option sort [String] Sorting method
        # @option base [String] Only Events occuring before this time will be used 
        # @return [Array<Sawyer::Resource>] List of values for the Pivots requested
        # @see http://docs.bugsnagapiv2.apiary.io/#reference/errors/pivots/list-values-of-a-pivot-on-an-error
        def pivot_values(project_id, ef_display_id, error_id=nil, options = {})
          if error_id.nil?
            paginate "projects/#{project_id}/pivots/#{ef_display_id}/values", options
          else
            paginate "projects/#{project_id}/errors/#{error_id}/pivots/#{ef_display_id}/values", options
          end
        end
      end
    end
  end
end
  

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
bugsnag-api-2.0.2	lib/bugsnag/api/client/pivots.rb
bugsnag-api-2.0.1	lib/bugsnag/api/client/pivots.rb
bugsnag-api-2.0.0	lib/bugsnag/api/client/pivots.rb