Module: Slack::Web::Api::Endpoints::AppsActivities

Included in:
Slack::Web::Api::Endpoints
Defined in:
lib/slack/web/api/endpoints/apps_activities.rb

Instance Method Summary collapse

Instance Method Details

#apps_activities_list(options = {}) ⇒ Object

Get logs for a specified app

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :app_id (Object) —

    The id of the app to get activities from.

  • :component_id (string) —

    The component id of log events to be returned. Will be ‘FnXXXXXX’ for functions, and ‘WfXXXXXX’ for worflows.

  • :component_type (string) —

    The component type of log events to be returned. Acceptable values are (‘events_api’, ‘workflows’, ‘functions’, ‘tables’).

  • :cursor (string) —

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request’s response_metadata. See pagination for more detail.

  • :limit (integer) —

    The maximum number of items to return.

  • :log_event_type (string) —

    The event type of log events to be returned.

  • :max_date_created (integer) —

    The latest timestamp of the log to retrieve (epoch microseconds).

  • :min_date_created (integer) —

    The earliest timestamp of the log to retrieve (epoch microseconds).

  • :min_log_level (string) —

    The minimum log level of the log events to be returned. Defaults to ‘info’. Acceptable values (in order of relative importance from smallest to largest) are (‘trace’, ‘debug’, ‘info’, ‘warn’, ‘error’, ‘fatal’).

  • :sort_direction (enum) —

    The direction you want the data sorted by (always by timestamp).

  • :source (string) —

    The source of log events to be returned. Acceptable values are (‘slack’, ‘developer’).

  • :team_id (string) —

    The team who owns this log.

  • :trace_id (string) —

    The trace id of log events to be returned.

Raises:

  • (ArgumentError)

See Also:



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/slack/web/api/endpoints/apps_activities.rb', line 40

def apps_activities_list(options = {})
  raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
  if block_given?
    Pagination::Cursor.new(self, :apps_activities_list, options).each do |page|
      yield page
    end
  else
    post('apps.activities.list', options)
  end
end