Module: Slack::Web::Api::Endpoints::AdminAppsActivities

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

Instance Method Summary collapse

Instance Method Details

#admin_apps_activities_list(options = {}) ⇒ Object

Get logs for a specified team/org

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.

  • :team_id (string) —

    The team who owns this log.

  • :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.

  • :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 and fatal.

  • :log_event_type (string) —

    The event type of log events to be returned.

  • :source (string) —

    The source of log events to be returned. Acceptable values are slack and developer.

  • :component_type (string) —

    The component type of log events to be returned. Acceptable values are events_api, workflows, functions and tables.

  • :component_id (string) —

    The component ID of log events to be returned. Will be FnXXXXXX for functions, and WfXXXXXX for workflows.

  • :trace_id (string) —

    The trace ID of log events to be returned.

  • :min_date_created (integer) —

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

  • :max_date_created (integer) —

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

  • :sort_direction (enum) —

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

See Also:



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

def admin_apps_activities_list(options = {})
  if block_given?
    Pagination::Cursor.new(self, :admin_apps_activities_list, options).each do |page|
      yield page
    end
  else
    post('admin.apps.activities.list', options)
  end
end