You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md
+42-44Lines changed: 42 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ manager: hikakar
15
15
16
16
## SYNOPSIS
17
17
18
-
18
+
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.
19
19
20
20
## SYNTAX
21
21
@@ -34,44 +34,6 @@ If this cmdlet is executed without any parameters, it displays the status of all
34
34
| Status | The status of the report. |
35
35
| ReportPeriodInDays | The report duration in days. |
36
36
37
-
If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `CopilotAgentsOnSites`, a report with list of all sites on which a Copilot agent is created along with the names of the Copilot agent created in last N days will be displayed with the following properties:
| Template | The Site template of the SharePoint site. |
44
-
| Site owner | Name of the owner of the SharePoint site. |
45
-
| Copilot name | Name of Copilot agent on the SharePoint site. |
46
-
| Sensitivity | The sensitivity label of the SharePoint site. |
47
-
| Restrict site access | RAC status (Yes/No) of the SharePoint site. |
48
-
| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. |
49
-
| External sharing | External Sharing status (Yes/No) of the SharePoint site. |
50
-
51
-
If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `TopSites`, the top 100 records summarizing the number of Copilot Agents on sites created in last N days will be displayed with the following properties:
| Template | The Site template of the SharePoint site. |
58
-
| Site owner | Name of the owner of the SharePoint site. |
59
-
| Copilot agents | Number of Copilot agents on the SharePoint site. |
60
-
| Sensitivity | The sensitivity label of the SharePoint site. |
61
-
| Restrict site access | RAC status (Yes/No) of the SharePoint site. |
62
-
| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. |
63
-
| External sharing | External Sharing status (Yes/No) of the SharePoint site. |
64
-
65
-
If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `SiteDistribution`, a report showing Copilot distribution across sites in last N days will be displayed with the following properties:
| Site template | The Site template of the SharePoint site. |
70
-
| Sites | Number of sites corresponding to that particular site template. |
71
-
| Copilot agents | Name of Copilot agent on the SharePoint site corresponding to that particular site template. |
72
-
73
-
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.
74
-
75
37
> [!NOTE]
76
38
> All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports).
77
39
@@ -91,21 +53,21 @@ Example 1 enables administrator to view the status of all active and completed r
Example 3 enables administrator to download the Copilot agent insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b` to the same path from where the command was run.
64
+
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.
103
65
104
66
## PARAMETERS
105
67
106
68
### -ReportId
107
69
108
-
It is an optional parameter, and it specifies the unique Id of the report to be viewed or downloaded.
70
+
It specifies the unique Id of the report to be viewed or downloaded.
It is an optional parameter, and it specifies the kind of report to view or download. There are 3 kinds of sub-reports: CopilotAgentsOnSites, TopSites, SiteDistribution.
87
+
It specifies the kind of report to view or download. There are 3 kinds of sub-reports: CopilotAgentsOnSites, TopSites, SiteDistribution.
88
+
89
+
If this cmdlet is executed with `-Content` as `CopilotAgentsOnSites`, a report with list of all sites on which a Copilot agent is created along with the names of the Copilot agent created in the specified number of days will be displayed with the following properties:
| Template | The Site template of the SharePoint site. |
96
+
| Site owner | Name of the owner of the SharePoint site. |
97
+
| Copilot name | Name of Copilot agent on the SharePoint site. |
98
+
| Sensitivity | The sensitivity label of the SharePoint site. |
99
+
| Restrict site access | RAC status (Yes/No) of the SharePoint site. |
100
+
| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. |
101
+
| External sharing | External Sharing status (Yes/No) of the SharePoint site. |
102
+
103
+
If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `TopSites`, the top 100 records summarizing the number of Copilot Agents on sites created in the specified number of days will be displayed with the following properties:
| Template | The Site template of the SharePoint site. |
110
+
| Site owner | Name of the owner of the SharePoint site. |
111
+
| Copilot agents | Number of Copilot agents on the SharePoint site. |
112
+
| Sensitivity | The sensitivity label of the SharePoint site. |
113
+
| Restrict site access | RAC status (Yes/No) of the SharePoint site. |
114
+
| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. |
115
+
| External sharing | External Sharing status (Yes/No) of the SharePoint site. |
116
+
117
+
If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `SiteDistribution`, a report showing Copilot distribution across sites in the specified number of days will be displayed with the following properties:
It is an optional parameter, and it specifies whether to view or download a specific report.
140
+
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.
After this cmdlet is executed, the Copilot Agent Insight report generation request for the last N days gets queued in the pipeline and the below metadata is displayed with the following properties:
28
+
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:
Example 2 generates the Copilot Agent insights report for a specified duration of 14 days.
53
+
Example 2 generates the Copilot agent insight report for a specified duration of 14 days.
54
54
55
55
## PARAMETERS
56
56
57
57
### -ReportPeriodInDays
58
58
59
-
It is an optional parameter, and it specifies the duration of the Copilot Agent insights 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.
59
+
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.
0 commit comments