Get-SPOCopilotAgentInsightsReport
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.
Note
The feature associated with this cmdlet will be rolling out soon.
Syntax
Default (Default)
Get-SPOCopilotAgentInsightsReport
[-ReportId <Guid>]
[-Action <ActionType>]
[-Content <SPOCopilotAgentInsightType>]
[<CommonParameters>]
Description
If this cmdlet is executed without any parameters, it displays the status of all active and completed reports.
Note
All reports adhere to any retention timeline as per Data Access Governance.
Examples
EXAMPLE 1
Get-SPOCopilotAgentInsightsReport
Example 1 enables administrator to view the status of all active and completed reports.
EXAMPLE 2
Get-SPOCopilotAgentInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b
Example 2 enables administrator to view the Copilot agent insight report of ReportId: 9d946216-afe7-49f5-8267-7b662435c70b.
EXAMPLE 3
Get-SPOCopilotAgentInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download
Example 3 enables administrator to download the Copilot agent insight report of ReportId: 9d946216-afe7-49f5-8267-7b662435c70b to the same path from where the command was run.
Parameters
-Action
Applicable: SharePoint Online
It determines whether a report would be viewed or downloaded. If the value of -Action is set as View, it will display the output on the PowerShell screen. Else if the value of -Action is set as Download, it will download the full report in CSV format to the same path from where the command was run.
Parameter properties
| Type: | ActionType |
| Default value: | View |
| Accepted values: | View, Download |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Content
Applicable: SharePoint Online
Specifies the type of report to view or download. Valid values are:
CopilotAgentsOnSites: Displays a report listing all sites where a Copilot agent was created within the specified number of days. Includes the names of the agents created.TopSites: Displays the top 100 sites with the highest number of Copilot agents created within the specified number of days.SiteDistribution: Displays a report showing how Copilot agents are distributed across sites within the specified number of days.
Parameter properties
| Type: | Microsoft.Online.SharePoint.TenantAdministration.SPOCopilotAgentInsightType |
| Default value: | CopilotAgentsOnSites |
| Accepted values: | CopilotAgentsOnSites, TopSites, SiteDistribution |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ReportId
Applicable: SharePoint Online
It specifies the unique Id of the report to be viewed or downloaded.
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.