Start-SPOCopilotAgentInsightsReport

Reference

Module:: Microsoft.Online.SharePoint.PowerShell

Applies to:: SharePoint Online

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.

Syntax

Start-SPOCopilotAgentInsightsReport
     [-ReportPeriodInDays <Int>]
     [-Force <SwitchParameter>]

Description

After this cmdlet is executed, the Copilot agent insight report generation request for the specified number of days gets queued in the pipeline and the below metadata is displayed with the following properties:

Property	Description
Id	The unique Id of the report.
CreatedDateTimeInUtc	The date and time in UTC when the report creation was triggered.
Status	The status of the report.
ReportPeriodInDays	The report duration in days.

Examples

-----------------------EXAMPLE 1-----------------------------

Start-SPOCopilotAgentInsightsReport

Example 1 generates the Copilot agent insight report for a default duration of 1 day since the parameter -ReportPeriodInDays is not provided.

-----------------------EXAMPLE 2-----------------------------

Start-SPOCopilotAgentInsightsReport -ReportPeriodInDays 14

Example 2 generates the Copilot agent insight report for a specified duration of 14 days.

Parameters

-Force

It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online

-ReportPeriodInDays

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.

Type:	Int
Position:	Named
Default value:	1
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online

Share via