From cb9a433b84d08da760bafda0077711a9ee4ba9f3 Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Wed, 18 Nov 2026 13:09:53 -0800 Subject: [PATCH] feat(web-api): add admin.analytics.members.activity method Co-authored-by: Claude --- .../admin-analytics-members-activity.md | 5 + packages/web-api/src/methods.ts | 12 +++ .../src/types/request/admin/analytics.ts | 28 ++++- packages/web-api/src/types/request/index.ts | 2 +- .../AdminAnalyticsMembersActivityResponse.ts | 102 ++++++++++++++++++ packages/web-api/src/types/response/index.ts | 1 + .../types/methods/admin.analytics.test-d.ts | 21 ++++ 7 files changed, 169 insertions(+), 2 deletions(-) create mode 100644 .changeset/admin-analytics-members-activity.md create mode 100644 packages/web-api/src/types/response/AdminAnalyticsMembersActivityResponse.ts diff --git a/.changeset/admin-analytics-members-activity.md b/.changeset/admin-analytics-members-activity.md new file mode 100644 index 000000000..1bb241ce4 --- /dev/null +++ b/.changeset/admin-analytics-members-activity.md @@ -0,0 +1,5 @@ +--- +"@slack/web-api": minor +--- + +feat(web-api): add [`admin.analytics.members.activity`](https://docs.slack.dev/reference/methods/admin.analytics.members.activity) method diff --git a/packages/web-api/src/methods.ts b/packages/web-api/src/methods.ts index 9c6fceb5e..645c5aa57 100644 --- a/packages/web-api/src/methods.ts +++ b/packages/web-api/src/methods.ts @@ -3,6 +3,7 @@ import { EventEmitter } from 'eventemitter3'; // Request, followed by response, types import type { AdminAnalyticsGetFileArguments, + AdminAnalyticsMembersActivityArguments, AdminAppsActivitiesListArguments, AdminAppsApproveArguments, AdminAppsApprovedListArguments, @@ -303,6 +304,7 @@ import type { } from './types/request/index'; import type { AdminAnalyticsGetFileResponse, + AdminAnalyticsMembersActivityResponse, AdminAppsActivitiesListResponse, AdminAppsApprovedListResponse, AdminAppsApproveResponse, @@ -671,6 +673,16 @@ export abstract class Methods extends EventEmitter { this, 'admin.analytics.getFile', ), + members: { + /** + * @description Retrieves activity metrics for each member of an organization or workspace for one day. + * @see {@link https://docs.slack.dev/reference/methods/admin.analytics.members.activity `admin.analytics.members.activity` API reference}. + */ + activity: bindApiCallWithOptionalArgument< + AdminAnalyticsMembersActivityArguments, + AdminAnalyticsMembersActivityResponse + >(this, 'admin.analytics.members.activity'), + }, }, apps: { activities: { diff --git a/packages/web-api/src/types/request/admin/analytics.ts b/packages/web-api/src/types/request/admin/analytics.ts index 496dd6620..b8cdc40d2 100644 --- a/packages/web-api/src/types/request/admin/analytics.ts +++ b/packages/web-api/src/types/request/admin/analytics.ts @@ -1,4 +1,5 @@ -import type { TokenOverridable } from '../common'; +import type { OptionalArgument } from '../../helpers'; +import type { CursorPaginationEnabled, TokenOverridable } from '../common'; interface Date { /** @@ -42,3 +43,28 @@ type PublicChannelArgs = PublicChannelWithDate | PublicChannelWithMetadata; // https://docs.slack.dev/reference/methods/admin.analytics.getFile export type AdminAnalyticsGetFileArguments = TokenOverridable & (MemberArgs | PublicChannelArgs); + +// https://docs.slack.dev/reference/methods/admin.analytics.members.activity +export type AdminAnalyticsMembersActivityArguments = OptionalArgument< + TokenOverridable & + CursorPaginationEnabled & { + /** @description The day to report on, as `YYYY-MM-DD` in UTC. Defaults to the most recent day with data. */ + date?: string; + /** @description Workspace ID to scope the results to. With an organization-level token, omit it for organization-wide results. */ + team_id?: string; + /** @description Member types to include. Omit to include every member type. */ + member_types?: ( + | 'regular_members' + | 'single_channel_guests' + | 'multi_channel_guests' + | 'frontline_members' + | 'org_owners' + | 'org_admins' + | 'workspace_owners' + | 'workspace_admins' + | 'invited' + )[]; + /** @description User IDs to return. Up to 500 IDs. Omit to return every member. */ + user_ids?: string[]; + } +>; diff --git a/packages/web-api/src/types/request/index.ts b/packages/web-api/src/types/request/index.ts index 6f5c96deb..d0ad7a840 100644 --- a/packages/web-api/src/types/request/index.ts +++ b/packages/web-api/src/types/request/index.ts @@ -1,4 +1,4 @@ -export type { AdminAnalyticsGetFileArguments } from './admin/analytics'; +export type { AdminAnalyticsGetFileArguments, AdminAnalyticsMembersActivityArguments } from './admin/analytics'; export type { AdminAppsActivitiesListArguments, AdminAppsApproveArguments, diff --git a/packages/web-api/src/types/response/AdminAnalyticsMembersActivityResponse.ts b/packages/web-api/src/types/response/AdminAnalyticsMembersActivityResponse.ts new file mode 100644 index 000000000..2ce85da4b --- /dev/null +++ b/packages/web-api/src/types/response/AdminAnalyticsMembersActivityResponse.ts @@ -0,0 +1,102 @@ +///////////////////////////////////////////////////////////////////////////////////////// +// // +// !!! DO NOT EDIT THIS FILE !!! // +// // +// This file is auto-generated by scripts/generate-web-api-types.sh in the repository. // +// Please refer to the script code to learn how to update the source data. // +// // +///////////////////////////////////////////////////////////////////////////////////////// + +import type { WebAPICallResult } from '../../WebClient'; +export type AdminAnalyticsMembersActivityResponse = WebAPICallResult & { + available_date_range?: AvailableDateRange; + date?: string; + error?: string; + members?: Member[]; + needed?: string; + ok?: boolean; + provided?: string; + response_metadata?: ResponseMetadata; + total_count?: number; + warning?: string; +}; + +export interface AvailableDateRange { + end_date?: string; + start_date?: string; +} + +export interface Member { + account_type?: string; + actions_taken_with_apps_count?: number; + active_day_count?: number; + active_on_android_day_count?: number; + active_on_desktop_day_count?: number; + active_on_ios_day_count?: number; + active_on_slack_connect_day_count?: number; + ai_assisted_workflow_drafts_created_count?: number; + ai_huddle_notes_generated_count?: number; + ai_usage_count?: number; + audio_clips_created_count?: number; + audio_clips_played_count?: number; + automations_executed_with_apps_count?: number; + canvases_created_count?: number; + canvases_edited_count?: number; + canvases_shared_count?: number; + canvases_viewed_count?: number; + channel_message_count?: number; + channel_summaries_viewed_count?: number; + clips_created_count?: number; + clips_played_count?: number; + comments_added_to_canvases_count?: number; + comments_added_to_lists_count?: number; + date_claimed?: number; + date_created?: number; + date_deleted?: number; + date_last_active?: number; + date_last_active_android?: number; + date_last_active_desktop?: number; + date_last_active_ios?: number; + enterprise_id?: string; + file_summaries_viewed_count?: number; + file_translations_generated_count?: number; + files_added_count?: number; + is_admin?: boolean; + is_invited_guest?: boolean; + is_invited_member?: boolean; + is_owner?: boolean; + is_primary_owner?: boolean; + is_restricted?: boolean; + is_ultra_restricted?: boolean; + keyword_search_summaries_viewed_count?: number; + lists_created_count?: number; + lists_edited_count?: number; + lists_shared_count?: number; + lists_viewed_count?: number; + max_channels_joined_count?: number; + message_count?: number; + message_explanations_viewed_count?: number; + message_translations_generated_count?: number; + messages_read_from_apps_count?: number; + messages_sent_to_slackbot_count?: number; + natural_language_search_summaries_viewed_count?: number; + reaction_count?: number; + reactions_added_to_canvases_count?: number; + recaps_viewed_count?: number; + search_count?: number; + slack_huddles_count?: number; + slackbot_skill_usage_count?: number; + slackbot_skills_created_count?: number; + team_id?: string; + thread_summaries_viewed_count?: number; + translations_generated_count?: number; + user_id?: string; + video_clips_created_count?: number; + video_clips_played_count?: number; + workflow_run_count?: number; +} + +export interface ResponseMetadata { + messages?: string[]; + next_cursor?: string; +} diff --git a/packages/web-api/src/types/response/index.ts b/packages/web-api/src/types/response/index.ts index a2037ddf5..7a4847024 100644 --- a/packages/web-api/src/types/response/index.ts +++ b/packages/web-api/src/types/response/index.ts @@ -4,6 +4,7 @@ export { AdminAnalyticsPublicChannelDetails, AdminAnalyticsPublicChannelMetadataDetails, } from './AdminAnalyticsGetFileResponse'; +export { AdminAnalyticsMembersActivityResponse } from './AdminAnalyticsMembersActivityResponse'; export { AdminAppsActivitiesListResponse } from './AdminAppsActivitiesListResponse'; export { AdminAppsApprovedListResponse } from './AdminAppsApprovedListResponse'; export { AdminAppsApproveResponse } from './AdminAppsApproveResponse'; diff --git a/packages/web-api/test/types/methods/admin.analytics.test-d.ts b/packages/web-api/test/types/methods/admin.analytics.test-d.ts index 65ef19c03..bde9cb663 100644 --- a/packages/web-api/test/types/methods/admin.analytics.test-d.ts +++ b/packages/web-api/test/types/methods/admin.analytics.test-d.ts @@ -61,3 +61,24 @@ expectAssignable>([ metadata_only: true, }, ]); + +// admin.analytics.members.activity +// -- sad path +expectError( + web.admin.analytics.members.activity({ + member_types: ['not_a_member_type'], // unknown member type + }), +); +// -- happy path +expectAssignable>([]); // no arg is fine +expectAssignable>([{}]); // empty arg is fine +expectAssignable>([ + { + date: '2026-09-30', + team_id: 'T1234', + member_types: ['regular_members', 'org_admins'], + user_ids: ['U1234', 'U5678'], + limit: 100, + cursor: '5c3e53d5', + }, +]);