Slack. Web. Admin. Analytics. Messages
(SlackKit v0.25.0-alpha.0)
View Source
Summary
Functions
Retrieves activity metrics for messages from a given channel.
Retrieves metadata for a list of messages from a given channel.
Functions
Retrieves activity metrics for messages from a given channel.
Required Params
channel- Channel ID for channel of the message activity to query.
Optional Params
cursor- Paginate through collections of data by setting thecursorparameter to anext_cursorattribute returned by a previous request'sresponse_metadata. Default value fetches the first "page" of the collection. ex:abcd...latest_ts- Most recent timestamp to include in results. Defaults to current time. If not passed while still passing theoldest_tsparameter, defaults to 7 days afteroldest_ts.limit- Maximum number of entries to return. The maximum limit is 100.oldest_ts- Oldest timestamp to include in the results. Defaults to 7 days before current time. If not passed while still passing thelatest_tsparameter, defaults to 7 days beforelatest_ts.
Errors the API can return:
token_revoked- Authentication token is for a deleted user or workspace or the app has been removed when using ausertoken.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 aPOSTrequest withContent-Typeapplication/x-www-form-urlencodedormultipart/form-data, but the form data was either missing or syntactically invalid.invalid_post_type- The method was called via aPOSTrequest, but the specifiedContent-Typewas invalid. Valid types are:application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.restricted_plan_level- The enterprise plan level does not have access to this feature.restricted_action- The token does not have permission to access this resource.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 theRetry-Afterheader for when to retry the request.ekm_access_denied- Administrators have suspended the ability to post a message.service_unavailable- The service is temporarily unavailableteam_access_not_granted- The token used is not granted the specific workspace access required to complete this request.invalid_arguments- Required arguments either were not provided or contain invalid values.invalid_array_arg- The method was passed an array as an argument. Please only input valid strings.request_timeout- The method was called via aPOSTrequest, but thePOSTdata was either missing or truncated.account_inactive- Authentication token is for a deleted user or workspace when using abottoken.channel_not_found- The specified channel was not found.not_authed- No authentication token provided.internal_error- The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.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 aPOSTrequest and included a data payload, but the request did not include aContent-Typeheader.accesslimited- Access to this method is limited on the current networktoken_expired- Authentication token has expiredinvalid_charset- The method was called via aPOSTrequest, but thecharsetspecified in theContent-Typeheader was invalid. Valid charset names are:utf-8iso-8859-1.method_deprecated- The method has been deprecated.not_an_enterprise- The user token does not belong to an enterprise.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.
Retrieves metadata for a list of messages from a given channel.
Required Params
channel- Channel ID for channel containing the messages to query.
Optional Params
cursor- Paginate through collections of data by setting thecursorparameter to anext_cursorattribute returned by a previous request'sresponse_metadata. Default value fetches the first "page" of the collection. See pagination for more details. ex:abcd...latest_ts- Most recent timestamp to include in the results. If not passed, defaults to current time.oldest_ts- Oldest timestamp to include in the results
Errors the API can return:
token_revoked- Authentication token is for a deleted user or workspace or the app has been removed when using ausertoken.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 aPOSTrequest withContent-Typeapplication/x-www-form-urlencodedormultipart/form-data, but the form data was either missing or syntactically invalid.invalid_post_type- The method was called via aPOSTrequest, but the specifiedContent-Typewas invalid. Valid types are:application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.restricted_plan_level- This feature is not available for your current product plan.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 theRetry-Afterheader for when to retry the request.ekm_access_denied- Administrators have suspended the ability to post a message.service_unavailable- The service is temporarily unavailableteam_access_not_granted- The token used is not granted the specific workspace access required to complete this request.analytics_unavailable- We were unable to find analytics for you.invalid_arguments- Required arguments either were not provided or contain invalid values.invalid_array_arg- The method was passed an array as an argument. Please only input valid strings.different_team_owns_message_metadata_for_channel- Message metadata must be accessed by an actor from the same team that owns the channel. This may be the org or a specific enterprise workspace.request_timeout- The method was called via aPOSTrequest, but thePOSTdata was either missing or truncated.account_inactive- Authentication token is for a deleted user or workspace when using abottoken.channel_not_found- The specified channel was not foundnot_authed- No authentication token provided.internal_error- The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.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 aPOSTrequest and included a data payload, but the request did not include aContent-Typeheader.accesslimited- Access to this method is limited on the current networktoken_expired- Authentication token has expiredinvalid_charset- The method was called via aPOSTrequest, but thecharsetspecified in theContent-Typeheader was invalid. Valid charset names are:utf-8iso-8859-1.method_deprecated- The method has been deprecated.admin_analytics_disabled- We're having issues returning your analytics. Please wait and try again.not_an_enterprise- The user token does not belong to an enterprise.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.