Class AdminAnalyticsGetFileResponse.AnalyticsData
java.lang.Object
com.slack.api.methods.response.admin.analytics.AdminAnalyticsGetFileResponse.AnalyticsData
- Enclosing class:
- AdminAnalyticsGetFileResponse
Parsed Analytics Data
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanboolean(public_channel) A count of people in this channel who have read or posted a message.(public_channel) The unique id belonging to this channel.(member) Total messages posted by the user in private channels and public channels on the date in the API request, not including direct messages Example: 30(public_channel) Indicates which kind of public channel this is: single_workspace_channel, multi_workspace_channel, or org_wide_channel.getDate()(member) (public_channel) The date this row of data is representative of (public_channel + metadata_only) These details are current as of this date, which is also when you're making this API call Example: 2020-09-13(member) The date of the very first time the member signed in to any workspace within the grid organization, presented in seconds since the epoch (UNIX time)(public_channel) The date and time the channel was first created, presented in seconds since the epoch (UNIX time).(public_channel) The date and time the channel last had a message posted in it, presented in seconds since the epoch (UNIX time).(public_channel + metadata_only) A longer description about the purpose of the channel Example: "Ask our editors all about their favorite literature"The email address of record for the same user Example: [email protected]This field is pulled from data synced via a SCIM API custom attribute Example: 273849373Unique ID of the involved Enterprise organization Example: E2AB3A10FThe canonical, organization-wide user ID this row concerns Example: W1F83A9F9(public_channel) Indicates which, if any, external organizations this channel is shared with.(member) Total files uploaded by the user on the date in the API request Example: 5(public_channel) A count of people in this channel who have a Full Member account.(public_channel) A count of people in this channel who have a guest account.Deprecated.(member) User has posted a message or read at least one channel or direct message on the date in the API request Example: true(member) User has posted a message or read at least one channel or direct message on the date in the API request via the Slack Android App Example: false(member) Returns true when this member has interacted with a Slack app or custom integration on the given day, or if such an app or integration has performed an action on the user's behalf, such as updating their custom status(member) User has posted a message or read at least one channel or direct message on the date in the API request via the Slack Desktop App Example: true(member) User has posted a message or read at least one channel or direct message on the date in the API request via the Slack iOS App Example: true(member) Returns true when the member is considered active on Slack Connect, in that they've read or posted a message to a channel or direct message shared with at least one external workspace(member) Returns true when this member has interacted with at least one workflow on a given day(member) User is classified as a billable user (included in the bill) on the date in the API request Example: false(member) User is classified as a guest (not a full workspace member) on the date in the API request Example: false(public_channel) A boolean value revealing whether the channel is shared with workspaces outside of this organization when set to true.(public_channel) A count of the unique number of human users (guests & full members) who posted a message on the given day Example: 3(public_channel) A count of the unique human users (guests & full members) who read a message on the given day Example: 225(public_channel) A count of total messages posted from Slack Members & guests (human users only) on the given day Example: 193(member) Total messages posted by the user on the date in the API request to all message and conversation types, whether public, private, multi-person direct message, etc.getName()(public_channel + metadata_only) The latest name of the channel Example: "ama"(public_channel) A JSON object with the team_id and name of the workspace that created this public channel Example: {"team_id":"T4C3G041C","name":"arcane"}(member) Total reactions added to any message type in any conversation type by the user on the date in the API request.(member) The number of searches this user performed in Slack on a given day(public_channel) Indicates which, if any, workspaces in the same organization this channel is shared with.(member) Total number of Slack calls made or joined on a given day, excluding any calls using third party software besides Slack calls(member) Total number of Slack Huddles made or joined on a given dayUnique ID of the involved workspacegetTopic()(public_channel + metadata_only) The latest channel topic Example: "Are Jack Kerouac's paragraphs too long?"(member) Total number of calls made or joined on a given day, including Huddles, Slack native calls and calls made using third party software besides Slack calls(public_channel) A count of total full members & guests Example: 7User ID(public_channel) Indicates whether the channel is public or private.inthashCode()voidsetActiveMembersCount(Integer activeMembersCount) (public_channel) A count of people in this channel who have read or posted a message.voidsetChannelId(String channelId) (public_channel) The unique id belonging to this channel.voidsetChannelMessagesPostedCount(Integer channelMessagesPostedCount) (member) Total messages posted by the user in private channels and public channels on the date in the API request, not including direct messages Example: 30voidsetChannelType(String channelType) (public_channel) Indicates which kind of public channel this is: single_workspace_channel, multi_workspace_channel, or org_wide_channel.void(member) (public_channel) The date this row of data is representative of (public_channel + metadata_only) These details are current as of this date, which is also when you're making this API call Example: 2020-09-13voidsetDateClaimed(Integer dateClaimed) (member) The date of the very first time the member signed in to any workspace within the grid organization, presented in seconds since the epoch (UNIX time)voidsetDateCreated(Integer dateCreated) (public_channel) The date and time the channel was first created, presented in seconds since the epoch (UNIX time).voidsetDateLastActive(Integer dateLastActive) (public_channel) The date and time the channel last had a message posted in it, presented in seconds since the epoch (UNIX time).voidsetDescription(String description) (public_channel + metadata_only) A longer description about the purpose of the channel Example: "Ask our editors all about their favorite literature"voidsetEmailAddress(String emailAddress) The email address of record for the same user Example: [email protected]voidsetEnterpriseEmployeeNumber(String enterpriseEmployeeNumber) This field is pulled from data synced via a SCIM API custom attribute Example: 273849373voidsetEnterpriseId(String enterpriseId) Unique ID of the involved Enterprise organization Example: E2AB3A10FvoidsetEnterpriseUserId(String enterpriseUserId) The canonical, organization-wide user ID this row concerns Example: W1F83A9F9voidsetExternallySharedWithOrganizations(List<AdminAnalyticsGetFileResponse.Organization> externallySharedWithOrganizations) (public_channel) Indicates which, if any, external organizations this channel is shared with.voidsetFilesAddedCount(Integer filesAddedCount) (member) Total files uploaded by the user on the date in the API request Example: 5voidsetFullMembersCount(Integer fullMembersCount) (public_channel) A count of people in this channel who have a Full Member account.voidsetGuestMembersCount(Integer guestMembersCount) (public_channel) A count of people in this channel who have a guest account.voidsetHuddlesCount(Integer huddlesCount) Deprecated.voidsetIsActive(Boolean isActive) (member) User has posted a message or read at least one channel or direct message on the date in the API request Example: truevoidsetIsActiveAndroid(Boolean isActiveAndroid) (member) User has posted a message or read at least one channel or direct message on the date in the API request via the Slack Android App Example: falsevoidsetIsActiveApps(Boolean isActiveApps) (member) Returns true when this member has interacted with a Slack app or custom integration on the given day, or if such an app or integration has performed an action on the user's behalf, such as updating their custom statusvoidsetIsActiveDesktop(Boolean isActiveDesktop) (member) User has posted a message or read at least one channel or direct message on the date in the API request via the Slack Desktop App Example: truevoidsetIsActiveIos(Boolean isActiveIos) (member) User has posted a message or read at least one channel or direct message on the date in the API request via the Slack iOS App Example: truevoidsetIsActiveSlackConnect(Boolean isActiveSlackConnect) (member) Returns true when the member is considered active on Slack Connect, in that they've read or posted a message to a channel or direct message shared with at least one external workspacevoidsetIsActiveWorkflows(Boolean isActiveWorkflows) (member) Returns true when this member has interacted with at least one workflow on a given dayvoidsetIsBillableSeat(Boolean isBillableSeat) (member) User is classified as a billable user (included in the bill) on the date in the API request Example: falsevoidsetIsGuest(Boolean isGuest) (member) User is classified as a guest (not a full workspace member) on the date in the API request Example: falsevoidsetIsSharedExternally(Boolean isSharedExternally) (public_channel) A boolean value revealing whether the channel is shared with workspaces outside of this organization when set to true.voidsetMembersWhoPostedCount(Integer membersWhoPostedCount) (public_channel) A count of the unique number of human users (guests & full members) who posted a message on the given day Example: 3voidsetMembersWhoViewedCount(Integer membersWhoViewedCount) (public_channel) A count of the unique human users (guests & full members) who read a message on the given day Example: 225voidsetMessagesPostedByMembersCount(Integer messagesPostedByMembersCount) (public_channel) A count of total messages posted from Slack Members & guests (human users only) on the given day Example: 193voidsetMessagesPostedCount(Integer messagesPostedCount) (member) Total messages posted by the user on the date in the API request to all message and conversation types, whether public, private, multi-person direct message, etc.void(public_channel + metadata_only) The latest name of the channel Example: "ama"voidsetOriginatingTeam(AdminAnalyticsGetFileResponse.OriginatingTeam originatingTeam) (public_channel) A JSON object with the team_id and name of the workspace that created this public channel Example: {"team_id":"T4C3G041C","name":"arcane"}voidsetReactionsAddedCount(Integer reactionsAddedCount) (member) Total reactions added to any message type in any conversation type by the user on the date in the API request.voidsetSearchCount(Integer searchCount) (member) The number of searches this user performed in Slack on a given dayvoidsetSharedWith(List<AdminAnalyticsGetFileResponse.SharedWith> sharedWith) (public_channel) Indicates which, if any, workspaces in the same organization this channel is shared with.voidsetSlackCallsCount(Integer slackCallsCount) (member) Total number of Slack calls made or joined on a given day, excluding any calls using third party software besides Slack callsvoidsetSlackHuddlesCount(Integer slackHuddlesCount) (member) Total number of Slack Huddles made or joined on a given dayvoidUnique ID of the involved workspacevoid(public_channel + metadata_only) The latest channel topic Example: "Are Jack Kerouac's paragraphs too long?"voidsetTotalCallsCount(Integer totalCallsCount) (member) Total number of calls made or joined on a given day, including Huddles, Slack native calls and calls made using third party software besides Slack callsvoidsetTotalMembersCount(Integer totalMembersCount) (public_channel) A count of total full members & guests Example: 7voidUser IDvoidsetVisibility(String visibility) (public_channel) Indicates whether the channel is public or private.toString()
-
Constructor Details
-
AnalyticsData
public AnalyticsData()
-
-
Method Details
-
getDate
(member) (public_channel) The date this row of data is representative of (public_channel + metadata_only) These details are current as of this date, which is also when you're making this API call Example: 2020-09-13 -
getEnterpriseId
Unique ID of the involved Enterprise organization Example: E2AB3A10F -
getEnterpriseUserId
The canonical, organization-wide user ID this row concerns Example: W1F83A9F9 -
getTeamId
Unique ID of the involved workspace -
getUserId
User ID -
getEmailAddress
The email address of record for the same user Example: [email protected] -
getEnterpriseEmployeeNumber
This field is pulled from data synced via a SCIM API custom attribute Example: 273849373 -
getIsGuest
(member) User is classified as a guest (not a full workspace member) on the date in the API request Example: false -
getIsBillableSeat
(member) User is classified as a billable user (included in the bill) on the date in the API request Example: false -
getIsActive
(member) User has posted a message or read at least one channel or direct message on the date in the API request Example: true -
getIsActiveIos
(member) User has posted a message or read at least one channel or direct message on the date in the API request via the Slack iOS App Example: true -
getIsActiveAndroid
(member) User has posted a message or read at least one channel or direct message on the date in the API request via the Slack Android App Example: false -
getIsActiveDesktop
(member) User has posted a message or read at least one channel or direct message on the date in the API request via the Slack Desktop App Example: true -
getReactionsAddedCount
(member) Total reactions added to any message type in any conversation type by the user on the date in the API request. Removing reactions is not included. This metric is not de-duplicated by message—if a user adds 3 different reactions to a single message, we will report 3 reactions (public_channel) A count of emoji reactions left on any message in channel on that given day by human users Example: 20 -
getMessagesPostedCount
(member) Total messages posted by the user on the date in the API request to all message and conversation types, whether public, private, multi-person direct message, etc. (public_channel) A count of total messages posted, including messages from apps and integration on the given day Example: 40 -
getChannelMessagesPostedCount
(member) Total messages posted by the user in private channels and public channels on the date in the API request, not including direct messages Example: 30 -
getFilesAddedCount
(member) Total files uploaded by the user on the date in the API request Example: 5 -
getIsActiveApps
(member) Returns true when this member has interacted with a Slack app or custom integration on the given day, or if such an app or integration has performed an action on the user's behalf, such as updating their custom status -
getIsActiveWorkflows
(member) Returns true when this member has interacted with at least one workflow on a given day -
getIsActiveSlackConnect
(member) Returns true when the member is considered active on Slack Connect, in that they've read or posted a message to a channel or direct message shared with at least one external workspace -
getTotalCallsCount
(member) Total number of calls made or joined on a given day, including Huddles, Slack native calls and calls made using third party software besides Slack calls -
getSlackCallsCount
(member) Total number of Slack calls made or joined on a given day, excluding any calls using third party software besides Slack calls -
getSlackHuddlesCount
(member) Total number of Slack Huddles made or joined on a given day -
getHuddlesCount
Deprecated.(member) Total number of Slack Huddles made or joined on a given day NOTE: "slack_huddles_count" field used to be "huddles_count" -
getSearchCount
(member) The number of searches this user performed in Slack on a given day -
getDateClaimed
(member) The date of the very first time the member signed in to any workspace within the grid organization, presented in seconds since the epoch (UNIX time) -
getOriginatingTeam
(public_channel) A JSON object with the team_id and name of the workspace that created this public channel Example: {"team_id":"T4C3G041C","name":"arcane"} -
getChannelId
(public_channel) The unique id belonging to this channel. The metadata_only mode will give you information like the channel's name Example: CNGL0K091 (public_channel + metadata_only) The channel's unique identifier -
getChannelType
(public_channel) Indicates which kind of public channel this is: single_workspace_channel, multi_workspace_channel, or org_wide_channel. Example: "single_workspace_channel" -
getVisibility
(public_channel) Indicates whether the channel is public or private. Only public channel analytics is available at this time. Example: "public" -
getDateCreated
(public_channel) The date and time the channel was first created, presented in seconds since the epoch (UNIX time). Example: 1452719593 -
getDateLastActive
(public_channel) The date and time the channel last had a message posted in it, presented in seconds since the epoch (UNIX time). Example: 1584820530 -
getTotalMembersCount
(public_channel) A count of total full members & guests Example: 7 -
getFullMembersCount
(public_channel) A count of people in this channel who have a Full Member account. Example: 6 -
getActiveMembersCount
(public_channel) A count of people in this channel who have read or posted a message. Example: 6 -
getGuestMembersCount
(public_channel) A count of people in this channel who have a guest account. Example: 1 -
getMessagesPostedByMembersCount
(public_channel) A count of total messages posted from Slack Members & guests (human users only) on the given day Example: 193 -
getMembersWhoPostedCount
(public_channel) A count of the unique number of human users (guests & full members) who posted a message on the given day Example: 3 -
getMembersWhoViewedCount
(public_channel) A count of the unique human users (guests & full members) who read a message on the given day Example: 225 -
getName
(public_channel + metadata_only) The latest name of the channel Example: "ama" -
getTopic
(public_channel + metadata_only) The latest channel topic Example: "Are Jack Kerouac's paragraphs too long?" -
getDescription
(public_channel + metadata_only) A longer description about the purpose of the channel Example: "Ask our editors all about their favorite literature" -
setDate
(member) (public_channel) The date this row of data is representative of (public_channel + metadata_only) These details are current as of this date, which is also when you're making this API call Example: 2020-09-13 -
setEnterpriseId
Unique ID of the involved Enterprise organization Example: E2AB3A10F -
setEnterpriseUserId
The canonical, organization-wide user ID this row concerns Example: W1F83A9F9 -
setTeamId
Unique ID of the involved workspace -
setUserId
User ID -
setEmailAddress
The email address of record for the same user Example: [email protected] -
setEnterpriseEmployeeNumber
This field is pulled from data synced via a SCIM API custom attribute Example: 273849373 -
setIsGuest
(member) User is classified as a guest (not a full workspace member) on the date in the API request Example: false -
setIsBillableSeat
(member) User is classified as a billable user (included in the bill) on the date in the API request Example: false -
setIsActive
(member) User has posted a message or read at least one channel or direct message on the date in the API request Example: true -
setIsActiveIos
(member) User has posted a message or read at least one channel or direct message on the date in the API request via the Slack iOS App Example: true -
setIsActiveAndroid
(member) User has posted a message or read at least one channel or direct message on the date in the API request via the Slack Android App Example: false -
setIsActiveDesktop
(member) User has posted a message or read at least one channel or direct message on the date in the API request via the Slack Desktop App Example: true -
setReactionsAddedCount
(member) Total reactions added to any message type in any conversation type by the user on the date in the API request. Removing reactions is not included. This metric is not de-duplicated by message—if a user adds 3 different reactions to a single message, we will report 3 reactions (public_channel) A count of emoji reactions left on any message in channel on that given day by human users Example: 20 -
setMessagesPostedCount
(member) Total messages posted by the user on the date in the API request to all message and conversation types, whether public, private, multi-person direct message, etc. (public_channel) A count of total messages posted, including messages from apps and integration on the given day Example: 40 -
setChannelMessagesPostedCount
(member) Total messages posted by the user in private channels and public channels on the date in the API request, not including direct messages Example: 30 -
setFilesAddedCount
(member) Total files uploaded by the user on the date in the API request Example: 5 -
setIsActiveApps
(member) Returns true when this member has interacted with a Slack app or custom integration on the given day, or if such an app or integration has performed an action on the user's behalf, such as updating their custom status -
setIsActiveWorkflows
(member) Returns true when this member has interacted with at least one workflow on a given day -
setIsActiveSlackConnect
(member) Returns true when the member is considered active on Slack Connect, in that they've read or posted a message to a channel or direct message shared with at least one external workspace -
setTotalCallsCount
(member) Total number of calls made or joined on a given day, including Huddles, Slack native calls and calls made using third party software besides Slack calls -
setSlackCallsCount
(member) Total number of Slack calls made or joined on a given day, excluding any calls using third party software besides Slack calls -
setSlackHuddlesCount
(member) Total number of Slack Huddles made or joined on a given day -
setHuddlesCount
Deprecated.(member) Total number of Slack Huddles made or joined on a given day NOTE: "slack_huddles_count" field used to be "huddles_count" -
setSearchCount
(member) The number of searches this user performed in Slack on a given day -
setDateClaimed
(member) The date of the very first time the member signed in to any workspace within the grid organization, presented in seconds since the epoch (UNIX time) -
setOriginatingTeam
(public_channel) A JSON object with the team_id and name of the workspace that created this public channel Example: {"team_id":"T4C3G041C","name":"arcane"} -
setChannelId
(public_channel) The unique id belonging to this channel. The metadata_only mode will give you information like the channel's name Example: CNGL0K091 (public_channel + metadata_only) The channel's unique identifier -
setChannelType
(public_channel) Indicates which kind of public channel this is: single_workspace_channel, multi_workspace_channel, or org_wide_channel. Example: "single_workspace_channel" -
setVisibility
(public_channel) Indicates whether the channel is public or private. Only public channel analytics is available at this time. Example: "public" -
setDateCreated
(public_channel) The date and time the channel was first created, presented in seconds since the epoch (UNIX time). Example: 1452719593 -
setDateLastActive
(public_channel) The date and time the channel last had a message posted in it, presented in seconds since the epoch (UNIX time). Example: 1584820530 -
setTotalMembersCount
(public_channel) A count of total full members & guests Example: 7 -
setFullMembersCount
(public_channel) A count of people in this channel who have a Full Member account. Example: 6 -
setActiveMembersCount
(public_channel) A count of people in this channel who have read or posted a message. Example: 6 -
setGuestMembersCount
(public_channel) A count of people in this channel who have a guest account. Example: 1 -
setMessagesPostedByMembersCount
(public_channel) A count of total messages posted from Slack Members & guests (human users only) on the given day Example: 193 -
setMembersWhoPostedCount
(public_channel) A count of the unique number of human users (guests & full members) who posted a message on the given day Example: 3 -
setMembersWhoViewedCount
(public_channel) A count of the unique human users (guests & full members) who read a message on the given day Example: 225 -
setName
(public_channel + metadata_only) The latest name of the channel Example: "ama" -
setTopic
(public_channel + metadata_only) The latest channel topic Example: "Are Jack Kerouac's paragraphs too long?" -
setDescription
(public_channel + metadata_only) A longer description about the purpose of the channel Example: "Ask our editors all about their favorite literature" -
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-