Get-SPOEnterpriseAppInsightsReport
This cmdlet enables the administrator to check status of all active and available reports when no report ID is present and to view or download a report if report ID is present.
Syntax
Get-SPOEnterpriseAppInsightsReport
[-ReportId <Guid>]
[-Action <ActionType>] Description
If this cmdlet is executed without any parameters, it displays the status of all active and completed reports with the following properties:
| Property | Description |
|---|---|
| Id | The unique Id of the report. |
| CreatedDateTimeInUtc | The date and time the report creation was triggered in UTC. |
| Status | The status of the report. |
| ReportPeriodInDays | The report duration in days. |
If this cmdlet is executed with -ReportId as parameter, the top 100 records of the report from the last N days will be displayed with the following properties:
| Property | Description |
|---|---|
| SiteName | The name of the SharePoint site. |
| SiteURL | The URL of the SharePoint site. |
| SiteSensitivity | The sensitivity label of the SharePoint site. |
| AppID | The AppID of the 3P application. |
| AppPermissions | The permissions granted to the 3P application. |
| RequestVoulme | The number of times the 3P application accessed the given SharePoint site. |
If this cmdlet is executed with both the parameters, i.e. -ReportId and -Action, and if the value of -Action is set as View, it will display the same result as described above. If the value of -Action is set to Download, it will download the full report in CSV format to the same path from where the command was run.
Note
All reports adhere to any retention timeline as per Data Access Governance.
Examples
-----------------------EXAMPLE 1-----------------------------
Get-SPOEnterpriseAppInsightsReportExample 1 enables administrator to view the status of all active and completed reports.
-----------------------EXAMPLE 2-----------------------------
Get-SPOEnterpriseAppInsightsReport -ReportId 9d946216-afe7-49f5-8267-7b662435c70bExample 2 enables administrator to view the enterprise application insights report of ReportId: 9d946216-afe7-49f5-8267-7b662435c70b
-----------------------EXAMPLE 3-----------------------------
Get-SPOEnterpriseAppInsightsReport - ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action DownloadExample 3 enables administrator to download the enterprise application insights report of ReportId: 9d946216-afe7-49f5-8267-7b662435c70b to the same path from where the command was run.
Parameters
-Action
It is an optional parameter, and it specifies whether to view or download a specific report.
| Type: | ActionType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-ReportId
It is an optional parameter, and it specifies the unique Id of the report to be viewed or downloaded.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |