Slack.Web.Apps.Activities (SlackKit v1.0.0-alpha.0)

View Source

Summary

Functions

Get logs for a specified app

Functions

list(app_id, optional_params \\ %{})

Get logs for a specified app

API reference

Rate limit: Tier 3: 50+ per minute
Scopes:

View on docs.slack.dev ↗

Required Params

  • app_id - The id of the app to get activities from. ex: A12345

Optional Params

  • component_id - The component id of log events to be returned. Will be 'FnXXXXXX' for functions, and 'WfXXXXXX' for workflows ex: Wf013SMGL4V9
  • component_type - The component type of log events to be returned. Acceptable values are ('events_api', 'workflows', 'functions', 'tables'). ex: workflows
  • cursor - 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. ex: bG9nX2lkOjc5NjQ1NA==
  • limit - The maximum number of items to return. ex: 100
  • log_event_type - The event type of log events to be returned. ex: test_log_event
  • max_date_created - The latest timestamp of the log to retrieve (epoch microseconds). ex: 1646665572336299
  • min_date_created - The earliest timestamp of the log to retrieve (epoch microseconds). ex: 1646665572336251
  • min_log_level - 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'). ex: info
  • sort_direction - The direction you want the data sorted by (always by timestamp) Acceptable values: asc desc ex: asc
  • source - The source of log events to be returned. Acceptable values are ('slack', 'developer'). ex: slack
  • team_id - The team who owns this log. ex: T12345
  • trace_id - The trace id of log events to be returned. ex: Tr432f2

Errors the API can return:

  • free_team_not_allowed - Feature is only available on a paid team.
  • invalid_app - App ID provided is not valid for team and user.
  • invalid_app_id - App ID provided is not valid.
  • invalid_args - Required arguments either were not provided or contain invalid values.
  • invalid_cursor - Value passed for cursor was not valid or is no longer valid.
  • restricted_plan_level - Feature is not available on this team

See the Common Errors guide for errors returned by every Web API method.