Skip to main content

admin.analytics.slackbot.tools method

The features within are only available to Slack workspaces on an Enterprise plan.

Don't have a paid plan? Join the Developer Program and provision a fully-featured sandbox for free.

Facts​

DescriptionRetrieve per-user Slackbot tool usage for an Enterprise organization on a single date, returned as paginated JSON.
Method Access
GET https://slack.com/api/admin.analytics.slackbot.tools
Scopes
Content types
application/x-www-form-urlencoded
Rate LimitsTier 3: 50+ per minute

Arguments​

Required arguments

tokenstringRequired

Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Example: xxxx-xxxxxxxxx-xxxx

Optional arguments

dateOptional

The date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC. If not provided, defaults to the latest date with available data. The response's available_date_range gives the earliest and latest dates you can request.

Example: 2026-09-13
cursorstringOptional

Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection.

Example: rINXW545qlMoCHsOvVoSbLyn
limitintegerOptional

Maximum number of tool entries to return per page, counted across all rows. Defaults to 500. Max allowed is 1000.

Default: 500

Usage info​

This method returns one row per user for whom Slackbot used at least one user-facing tool on a given date. Each row lists the tools along with how many times Slackbot used each one on the user's behalf.

Omit date to get the latest date with available data. The available_date_range object in the response gives the earliest and latest dates you can request.

The limit argument counts tool entries across all rows, not rows. When a page ends partway through a user's tools, the rest continue in a row with the same user_id at the start of the next page, so merge rows that share a user_id.

Response​

Successful response with one page of per-user tool usage. The second row omits email_address because the organization hides guest email addresses.

{
  "ok": true,
  "date": "2026-09-13",
  "available_date_range": {
    "start_date": "2025-09-14",
    "end_date": "2026-09-13"
  },
  "tool_usage": [
    {
      "date": "2026-09-13",
      "enterprise_id": "E123ABC456",
      "user_id": "W111AAA111",
      "email_address": "person@acme.com",
      "tools": [
        {
          "name": "Web Search",
          "use_count": 5
        },
        {
          "name": "Update Slack Canvas",
          "use_count": 3
        }
      ]
    },
    {
      "date": "2026-09-13",
      "enterprise_id": "E123ABC456",
      "user_id": "W222BBB222",
      "tools": [
        {
          "name": "Web Search",
          "use_count": 1
        }
      ]
    }
  ],
  "response_metadata": {
    "next_cursor": "rINXW545qlMoCHsOvVoSbLyn"
  }
}

Error response when date is not a real date

{
  "ok": false,
  "error": "invalid_arguments"
}

Errors​

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok parameter in the response.

Error
Description
access_denied

Access to a resource specified in the request is denied.

accesslimited

Access to this method is limited on the current network

account_inactive

Authentication token is for a deleted user or workspace when using a bot token.

data_not_available_for_date

Analytics are not available for date. Call the method without date and use available_date_range from the response to find the supported dates.

date_before_created_date

date is before the organization was created.

deprecated_endpoint

The endpoint has been deprecated.

ekm_access_denied

Administrators have suspended the ability to post a message.

enterprise_is_restricted

The method cannot be called from an Enterprise.

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.

feature_not_available

Slackbot analytics is not available for this organization.

internal_error

Something went wrong on our end, please try again.

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.

invalid_arguments

Required arguments either were not provided or contain invalid values, including a date that is not a real calendar day.

invalid_array_arg

The method was passed an array as an argument. Please only input valid strings.

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.

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.

invalid_cursor

Value passed for cursor was not valid, or was issued for a different date.

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.

method_deprecated

The method has been deprecated.

missing_argument

A required argument was not provided. The response's arg field names the missing argument. Arguments sent in a JSON body are ignored by methods that don't list application/json as a content type.

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.

missing_scope

The token used is not granted the specific scope permissions required to complete this request.

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.

not_allowed_token_type

The token type used in this request is not allowed.

not_an_enterprise

The token does not belong to an Enterprise organization.

not_authed

No authentication token provided.

org_login_required

The workspace is undergoing an enterprise migration and will not be available until migration is complete.

ratelimited

The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

request_timeout

The method was called via a POST request, but the POST data was either missing or truncated.

restricted_action

The token does not have permission to access Slackbot analytics.

restricted_plan_level

The enterprise plan level does not have access to this feature.

service_unavailable

The service is temporarily unavailable

team_access_not_granted

The token used is not granted the specific workspace access required to complete this request.

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.

token_expired

Authentication token has expired

token_revoked

Authentication token is for a deleted user or workspace or the app has been removed when using a user token.

two_factor_setup_required

Two factor setup is required.