sharePointReportSettings: enableApiUsageReport

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.

Enable a SharePoint API usage report metric for the tenant. After you enable a metric, SharePoint starts collecting and reporting data for that specific usage metric.

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.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	ReportSettings.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

HTTP request

POST /admin/reportSettings/sharePoint/enableApiUsageReport

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the parameters.

The following table lists the parameters that are required when you call this action.

Parameter	Type	Description
metric	String	The name of the API usage report metric to enable. Currently, only EgressReport is supported. Required.

Response

If successful, this action returns a 200 OK response code and an apiUsageReportEnablementStatus object in the response body.

Examples

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/admin/reportSettings/sharePoint/enableApiUsageReport
Content-Type: application/json

{
  "metric": "EgressReport"
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

{
  "@odata.type": "#microsoft.graph.apiUsageReportEnablementStatus",
  "metric": "EgressReport",
  "onboardingStatus": "enabling"
}