Table of Contents

Retrieve Site Detail Records

This API method (/insights/sites/{siteId}/detailRecords navigation property) allows users to retrieve detailed records for a specific SharePoint site. This method is useful for obtaining comprehensive information about the site content's properties and activities.

Permission

The following permission is required to call this API.
You must register an app through AvePoint Online Services > App registration to authenticate and authorize your access to AvePoint Graph API. For details, refer to Authentication and Authorization.

API Permission required
/insights/sites/{siteId}/detailRecords insights.graph.readwrite.all

Request

This section outlines the HTTP method and endpoint used to retrieve the detail records within a site. It provides a concise description of the action performed by the API call.

HTTP Method Endpoint Description
GET /insights/sites/{siteId}/detailRecords Retrieves the detail records within a site.

Query Parameters

The API supports several query parameters to refine and customize the data retrieval process. These parameters allow users to specify the site ID to filter the results effectively.

Parameter Description Type Required?
siteId SharePoint site ID string Yes
nextLink Sets whether to get the remaining results of a request of which the results are more than 100 string No

Responses

The API response provides detailed information about the site detail records retrieved. Each record in the response includes various attributes that describe its properties and status.

Elements Description Type
status The HTTP response status code integer
message The error message string
nextLink The token to be used to get the remaining results of this request string
values A list of detail records in the site list

Detail record

Elements Description Type
id Unique identifier for the object string
name Name of the object string
location URL where the object is stored string
objectType Type of object string
createdBy User who created the object string
module Module or application where the object belongs string
inheritType Indicates whether the object inherits permissions from its parent string
siteName Name of the SharePoint site where the object is stored string
sensitivityLevel Sensitivity level of the object string
exposureLevel Exposure level of the object string
scannedTime Timestamp when the object was last scanned string
createdTime Timestamp when the object was created string
modifiedTime Timestamp when the object was last modified string
channelName Name of the Microsoft Teams channel where the object is shared string
riskLevel Risk level associated with the object string
privacy Privacy setting of the object string
sensitiveInfoType Types of sensitive information contained in the object list
sensitivityLabel Sensitivity label applied to the object string
tagName Tag associated with the object string
retentionLabel Retention label applied to the object string
creatorEmail Email of the user who created the object string
webUrl URL of the SharePoint site where the object is stored string

Request Sample

To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references. This will return the relevant site detail records in a structured format, enabling easy integration with other systems or applications. The following request is an API call to the Insights for Microsoft 365 environment in the US - East region.

https://graph-us.avepointonlineservices.com/insights/sites/0d6c1549-cd2d-4dd2-94b5-28df6da1f7e2/detailrecords?nextLink=1312312

Response Sample

The following response returns a list of detail records in the queried site with their properties and statuses in a structured format.

{
  "values": [
    {
      "id": "b68d7583-7583-7583-7583-7583758375837583", // Unique identifier for the object
      "name": "7583.xlsx", // Name of the object
      "location": "https://alita*******market7583.sharepoint.com/sites/7583teams-7583channel/shared documents/7583.xlsx", // URL where the object is stored
      "objectType": "object", // Type of object, in this case, a object
      "createdBy": "alita ******7583Rename", // User who created the object
      "module": "Microsoft Teams", // Module or application where the object is used
      "inheritType": "Unique", // Indicates if the object inherits permissions from its parent
      "siteName": "7583Teams-7583channel", // Name of the SharePoint site where the object is stored
      "sensitivityLevel": "Low", // Sensitivity level of the object
      "exposureLevel": "Low", // Exposure level of the object
      "scannedTime": "2024-11-11T02:46:58Z", // Timestamp when the object was last scanned
      "createdTime": "2024-02-22T02:28:40Z", // Timestamp when the object was created
      "modifiedTime": "2024-02-22T02:28:40Z", // Timestamp when the object was last modified
      "channelName": "7583channel", // Name of the Microsoft Teams channel where the object is shared
      "riskLevel": "Low", // Risk level associated with the object
      "privacy": "Private", // Privacy setting of the object
      "sensitiveInfoType": [
        "Mi CR 2" // Types of sensitive information contained in the object
      ],
      "sensitivityLabel": "******object Only Label", // Sensitivity label applied to the object
      "tagName": "", // Tag associated with the object
      "retentionLabel": null, // Retention label applied to the object
      "creatorEmail": "admin@alita***market7583.onmicrosoft.com" // Email of the user who created the object
       "webUrl": "https://alita*******market7583.sharepoint.com/sites/7583teams-7583channel" // URl of the SharePoint site where the object is stored
    },
    {
      "id": "d5ccd5cc-d5cc-d5cc-d5cc-d5ccd5ccd5cc", // Unique identifier for the object
      "name": "d5ccPP.pptx", // Name of the object
      "location": "https://alita*******market7583.sharepoint.com/sites/7583teams-7583channel/shared documents/d5ccp.pptx", // URL where the object is stored
      "objectType": "object", // Type of object, in this case, a object
      "createdBy": "alita************", // User who created the object
      "module": "Microsoft Teams", // Module or application where the object is used
      "inheritType": "Inheritance", // Indicates if the object inherits permissions from its parent
      "siteName": "******Teams-****channel", // Name of the SharePoint site where the object is stored
      "sensitivityLevel": "N/A", // Sensitivity level of the object
      "exposureLevel": "Medium", // Exposure level of the object
      "scannedTime": "2024-11-01T09:22:18Z", // Timestamp when the object was last scanned
      "createdTime": "2024-04-03T06:57:39Z", // Timestamp when the object was created
      "modifiedTime": "", // Timestamp when the object was last modified
      "channelName": "**********channel", // Name of the Microsoft Teams channel where the object is shared
      "riskLevel": "N/A", // Risk level associated with the object
      "privacy": "Private", // Privacy setting of the object
      "sensitiveInfoType": [], // Types of sensitive information contained in the object
      "sensitivityLabel": null, // Sensitivity label applied to the object
      "tagName": "", // Tag associated with the object
      "retentionLabel": "", // Retention label applied to the object
      "creatorEmail": "a***@alita***.onmicrosoft.com" // Email of the user who created the object
      "webUrl": "https://alita*******market7583.sharepoint.com/sites/7583teams-7583channel" // URl of the SharePoint site where the object is stored
    }
  ],
  "status": 200, // HTTP status code indicating the operation is successful.
  "message": "",
  "nextLink": null
}