Skip to content

itemanalytics-get.md

Latest commit

 

History

History
145 lines (104 loc) · 4.81 KB

itemanalytics-get.md

File metadata and controls

145 lines (104 loc) · 4.81 KB
author daspek
description Get itemAnalytics about the views that took place under this resource.
title Get analytics
ms.localizationpriority medium
doc_type apiPageType
ms.subservice sharepoint
ms.date 04/05/2024

Get analytics

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get itemAnalytics about the views that took place under this resource. The itemAnalytics resource is a convenient way to get activity stats for allTime and the lastSevenDays. For a custom time range or interval, use the getActivitiesByInterval API.

Note: The itemAnalytics resource is not yet available in all national deployments.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

GET /drives/{drive-id}/items/{item-id}/analytics
GET /sites/{site-id}/analytics
GET /sites/{site-id}/lists/{list-id}/items/{item-id}/analytics

Note

The value for {item-id} in the /sites/{site-id}/lists/{list-id}/items/{item-id} request is the listItemUniqueId. To get the listItemUniqueId of an item, call the /sites/{site-id}/lists/{list-id}/items/{item-id}?$select=sharepointIds endpoint. For details, see sharePointIds.

Optional query parameters

This method supports the OData query parameters to help customize the response.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of itemAnalytics objects in the response body.

Example

Request

The following example shows a request.

HTTP

GET /drives/{drive-id}/items/{item-id}/analytics

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-type: application/json

{
    "allTime": {
        "access": {
            "actionCount": 123,
            "actorCount": 89
        }
    },
    "lastSevenDays": {
        "access": {
            "actionCount": 52,
            "actorCount": 41
        }
    }
}