Slack.Web.Admin.Apps.Activities (SlackKit v0.25.0-alpha.0)

View Source

Summary

Functions

Get logs for a specified team/org

Functions

list(optional_params \\ %{})

Get logs for a specified team/org

Optional Params

  • app_id - The ID of the app to get activities from. ex: A12345
  • 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 and 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 and 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 and 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:

  • invalid_cursor - Value passed for cursor was not valid or is no longer valid.
  • token_revoked - Authentication token is for a deleted user or workspace or the app has been removed when using a user token.
  • invalid_arg_name - The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.
  • two_factor_setup_required - Two factor setup is required.
  • invalid_form_data - The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.
  • invalid_post_type - The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.
  • fatal_error - The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
  • deprecated_endpoint - The endpoint has been deprecated.
  • ratelimited - The request has been ratelimited. Refer to the Retry-After header for when to retry the request.
  • ekm_access_denied - Administrators have suspended the ability to post a message.
  • service_unavailable - The service is temporarily unavailable
  • invalid_app - App ID provided is not valid for team and user.
  • team_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
  • invalid_arguments - The method was called with invalid arguments.
  • invalid_array_arg - The method was passed an array as an argument. Please only input valid strings.
  • request_timeout - The method was called via a POST request, but the POST data was either missing or truncated.
  • account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
  • not_authed - No authentication token provided.
  • internal_error - Something went wrong on our end, please try again.
  • enterprise_is_restricted - The method cannot be called from an Enterprise.
  • no_permission - The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
  • access_denied - Access to a resource specified in the request is denied.
  • team_added_to_org - The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
  • missing_scope - The token used is not granted the specific scope permissions required to complete this request.
  • missing_post_type - The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
  • accesslimited - Access to this method is limited on the current network
  • invalid_args - Required arguments either were not provided or contain invalid values.
  • invalid_team - Team ID provided is not valid
  • token_expired - Authentication token has expired
  • invalid_charset - The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.
  • method_deprecated - The method has been deprecated.
  • invalid_app_id - App ID provided is not valid.
  • not_allowed_token_type - The token type used in this request is not allowed.
  • org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration is complete.
  • invalid_auth - Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.