Configure MyAnalytics

Role: Office 365 admins

The steps in this topic describe how to configure MyAnalytics for the users in your organization. Note the following:

  • Prerequisite: Users have access to MyAnalytics only if they have licenses that include the MyAnalytics service plan, as described in plans and environments for MyAnalytics.

  • Data privacy: See the MyAnalytics privacy guide to understand how privacy is built into MyAnalytics and to learn what you can configure to address specific privacy requirements.

To configure MyAnalytics:

Note

When you set the defaults (at either the tenant or user level), users can individually override these settings. For example, if you keep the dashboard tenant setting as opt in, users can open the dashboard and opt themselves out. Similarly, if you opt out users with a user-level setting, those users can choose to opt back in. The exception is if a user's license with a MyAnalytics service plan expires, that user cannot opt in.

Assign licenses with a MyAnalytics service plan

MyAnalytics is available to users who are assigned a license with a MyAnalytics service plan. For more details about which licenses have MyAnalytics service plans and when users get access to MyAnalytics elements after license assignment, see plans and environments for MyAnalytics.

For information on how to assign a license, see Assign licenses to users in Office 365 for business.

Note

If you want to notify your organization before you assign licenses with a MyAnalytics service plan, you can use this email template. You can download it, customize it with your company's information, and then email it to the new MyAnalytics participants. To learn more about adopting MyAnalytics, see Adopt MyAnalytics.

Configure access at the tenant level

You can configure access to MyAnalytics elements for all users in your organization.

To get access to the dashboard and email digests

Note

  • Tenants in the UAE, South Africa, and Singapore regions might obtain this functionality with some delay.
  • After a new tenant is established, it might take up to 48 hours for this functionality to become available.
  1. Sign in to the Microsoft 365 admin center.

  2. Make sure you're using the new admin center. To do this, if the switch in the upper right of the page reads Try the new admin center, select it so that it reads The new admin center:

    New admin center

  3. In the left pane, expand Settings, and then select Services & add-ins.

  4. Under Services & add-ins, select MyAnalytics. This opens a page to configure access to MyAnalytics elements.

    Select visibility

  5. Select Insights dashboard to keep all MyAnalytics users in your organization opted in for access to the MyAnalytics dashboard. Deselect Insights dashboard to opt users out of access to the dashboard.

  6. Select Weekly insights email to keep all MyAnalytics users in your organization opted in for access to email digests. Deselect Weekly insights email to opt users out of email digests.

To disable the add-in for a tenant

You can disable the Insights Outlook add-in for all licensed users in your organization or at the tenant level through the Exchange admin center.

  1. Open the Microsoft 365 admin center.
  2. In the left navigation pane, select Exchange. This opens the dashboard of the Exchange admin center. (If Exchange is not visible, first select Show all to see more admin centers and then select Exchange.)
  3. In the dashboard, select add-ins.
  4. In the list of add-ins, select Insights, and then select the Edit (pencil) icon.
  5. In the Edit add-in settings dialog box, clear the Make this add-in available to users in your organization checkbox to disable the add-in, and then select Save.

Configure access at the user level

Configure MyAnalytics access for individual users in your organization. At this level, you can opt-out the user completely, which would turn off all MyAnalytics functionality for that user. However, the user can choose to opt back in.

You can configure MyAnalytics (change its default behavior) for users in your organization by setting the PrivacyMode parameter. For information about the values of PrivacyMode, see User configuration settings.

You can set this parameter for one or many users:

User configuration settings

PrivacyMode parameter Licensed user Unlicensed user
Opt-in (default setting)
  • Office 365 data is used for aggregated information shown to licensed users
  • Dashboard is available
  • User can opt out
  • Office 365 data is used for aggregated information shown to licensed users
  • Admins can opt out unlicensed users through the admin PowerShell
Opt-out
  • Office 365 data is not used for aggregated information shown to licensed users
  • Dashboard is not available
  • User can opt in through the Feature settings menu
  • Office 365 data is not used for aggregated information shown to licensed users.

Important

The Excluded value of PrivacyMode is being retired. Users whose privacy mode was previously set to Excluded will now be set to Opt-out.

Set MyAnalytics access for one user

Configure MyAnalytics access settings for a user with the following PowerShell cmdlet:

Set-UserAnalyticsConfig –Identity <string> [PrivacyMode <string[]>]
Parameter Required Description Default value
Identity Yes User ID for the current user as stored in Azure Active Directory (AAD) --
PrivacyMode Yes
  • Opt-out: MyAnalytics won't use the user's data to compute derived statistics for other users. The user won't see statistics in MyAnalytics, but can choose to opt in from the Feature settings menu.
  • Opt-in: MyAnalytics uses the user's data to compute derived statistics for other users. The user can see statistics in MyAnalytics, but can choose to opt out from the Feature settings menu.
Opt-in

Important

The Excluded value of PrivacyMode is being retired. Users whose privacy mode was previously set to Excluded will now be set to Opt-out.

Confirm MyAnalytics access for a user

Use the following to confirm if a user has access to MyAnalytics (the value for PrivacyMode):

Get-UserAnalyticsConfig –Identity <string>
Parameter Required Description Default value
Identity Yes User ID for the current user as stored in AAD -

Set MyAnalytics access for multiple users

You can use the following steps in PowerShell to change access to MyAnalytics (the value of PrivacyMode) for multiple users by running a PowerShell script that iterates through the users, changing the value one user at a time.

  1. Create a comma-separated value (.csv) text file that contains the UserPrincipalName field and the location of the users you want to configure. For example:

    UserPrincipalName,UsageLocation
    ClaudeL@contoso.onmicrosoft.com,FR
    LynneB@contoso.onmicrosoft.com,US
    ShawnM@contoso.onmicrosoft.com,US
    
  2. Specify the location of the input .csv file, the output .csv file, and the value of PrivacyMode that you want to set for each user:

    $inFileName="<path and file name of the input .csv file that contains the users, example: C:\admin\Users2License..csv>"
    $outFileName="<path and file name of the output .csv file that records the results, example: C:\admin\Users2License-Done..csv>"
    $privacyMode = "Opt-in"
    
    $users=Import-Csv $inFileName
    ForEach ($user in $users)
    {
    $user.Userprincipalname
    $upn=$user.UserPrincipalName
    
    Set-UserAnalyticsConfig –Identity $upn -PrivacyMode $privacyMode
    Get-UserAnalyticsConfig –Identity $upn | Export-Csv $outFileName
    }
    
  3. Run the resulting commands at the PowerShell command prompt. For more information about the Exchange Online PowerShell, see Connect to Exchange Online PowerShell.

This PowerShell script:

  • Displays the user principal name for each user.
  • Sets the specified privacy mode for each user.
  • Creates a .csv file with all the users that were processed and shows their status.