Commands › SharePoint Online

Start-SPOCopilotAgentInsightsReport

SharePoint Online Microsoft.Online.SharePoint.PowerShell Start-*

Using this cmdlet, administrators may trigger the build of a new Copilot agent insight report for the specified number of days. > [!NOTE] > The feature associated with this cmdlet will be rolling out soon.

Quick start script

# Start-SPOCopilotAgentInsightsReport — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-SPOService -Url https://$org-admin.sharepoint.com

# 2. Run and inspect
Start-SPOCopilotAgentInsightsReport | Format-List

# 3. Export for evidence / drift tracking
Start-SPOCopilotAgentInsightsReport | Export-Clixml .\SPOCopilotAgentInsightsReport-$(Get-Date -Format yyyyMMdd).xml

Syntax

Start-SPOCopilotAgentInsightsReport [-Force] [-ReportPeriodInDays <Int32>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Parameters (4)

ParameterTypeRequiredWhat it controls
-Force SwitchParameter It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions.
-ReportPeriodInDays Int32 It specifies the duration of the Copilot agent insight report in days. The possible values of ReportPeriodInDays are: 1, 7, 14, 28. If this parameter is not provided, it generates the report for a default duration of 1 day.
-Confirm SwitchParameter Prompts you for confirmation before running the cmdlet.
-WhatIf SwitchParameter Shows what would happen if the cmdlet runs. The cmdlet is not run.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.