insightsSettings resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents settings to calculate and manage the display or programmatic return of a specific type of insights in an organization. The insights can be contact insights, item insights, meeting hours insights, or people insights.

Contact insights represent intelligent suggestions to organize user contacts in Microsoft 365. Programmatically, user contacts are represented by the contact resource. An example of a contact insight is merge suggestions for duplicate contacts, available for end users in Outlook.

Item insights and meeting hours insights represent relationships between users and items such as documents, sites, and other content types in Microsoft 365. Programmatically, they're represented by the itemInsights resource. You can get documents that are shared with a user, trending around a user, or used by a user. You can use insightsSettings to customize the privacy settings for calculating, displaying, or returning item insights in an organization.

People insights represent connections of people who are relevant to or work with one another based on their public relationships. Programmatically, individual people are represented by the person resource. You can use the people API to get people insights. You can use insightsSettings to customize the privacy settings for displaying or returning people insights.

In contrast, for item insights and meeting hours insights, you can also manage their calculation and visibility at a user level by using the userInsightsSettings resource.

Methods

Method Return Type Description
List contactInsights insightsSettings Get the properties of the insightsSettings resource for displaying contact insights in an organization.
List itemInsights insightsSettings Get the properties of an insightsSettings object for displaying or returning item insights in an organization.
List peopleInsights insightsSettings Get the properties of the insightsSettings resource for displaying people insights in an organization.
Update insightsSettings insightsSettings Update the properties of an insightsSettings resource to manage the display or return of the specified type of insights, which can be contact insights, item insights, or people insights.

Properties

Property Type Description
disabledForGroup String The ID of a Microsoft Entra group, of which the specified type of insights are disabled for its members. The default value is null. Optional.
isEnabledInOrganization Boolean true if insights of the specified type are enabled for the organization; false if insights of the specified type are disabled for all users without exceptions. The default value is true. Optional.

JSON representation

The following JSON representation shows the resource type.

{
  "disabledForGroup": "String",
  "isEnabledInOrganization": "Boolean"
}