officeGraphInsights resource type

  • Article

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.

Note

Use itemInsights instead of officeGraphInsights to access the insights API.

officeGraphInsights is maintained for backward compatibility with earlier versions of the insights API. It's the base type for itemInsights.

Insights are relationships calculated using advanced analytics and machine learning techniques. You can, for example, identify OneDrive for work or school documents trending around users.

Insights are returned by the following APIs:

  • Trending - returns documents from OneDrive for work or school and from SharePoint sites trending around a user.
  • Used - returns documents viewed or modified by a user. Includes documents the user used in OneDrive for work or school, and SharePoint.
  • Shared - returns documents shared with or by the user. Documents can be shared as URLs, file attachments, reference attachments to OneDrive for work or school and SharePoint files found in Outlook messages and meetings.

Each insight is returned with a resourceVisualization and resourceReference complex value type (CVT). The resourceVisualization CVT contains properties such as title and previewImageUrl. Microsoft uses the visualization properties to render the files in experiences like Office Delve.

Properties

None.

Relationships

Relationship Type Description
shared sharedInsight collection Access this property from the derived type itemInsights.
trending trending collection Access this property from the derived type itemInsights.
used usedInsight collection Access this property from the derived type itemInsights.

JSON representation

The following JSON representation shows the resource type.

{
  "id": "string",
  "shared": [ { "@odata.type": "microsoft.graph.shared" } ],
  "trending": [ { "@odata.type": "microsoft.graph.trending" } ],
  "used": [ { "@odata.type": "microsoft.graph.used" } ]
}