Skip to content

Commit 1c0268d

Browse files
sgiehlcaddoo
sgiehl
and
caddoo
authored
Adds Overview subcategory to AI Assistants (#23781)
* Adds Overview subcategory to AI Assistants * updates expected test files --------- Co-authored-by: caddoo <[email protected]>
1 parent 79d6722 commit 1c0268d

10 files changed

+51
-16
lines changed

‎plugins/AIAgents/Categories/AIAssistantsOverviewSubcategory.php‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<?php
2+
3+
/**
4+
* Matomo - free/libre analytics platform
5+
*
6+
* @link https://matomo.org
7+
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
8+
*/
9+
10+
declare(strict_types=1);
11+
12+
namespace Piwik\Plugins\AIAgents\Categories;
13+
14+
use Piwik\Category\Subcategory;
15+
use Piwik\Piwik;
16+
17+
class AIAssistantsOverviewSubcategory extends Subcategory
18+
{
19+
protected $categoryId = 'AIAgents_AIAssistants';
20+
protected $id = 'General_Overview';
21+
protected $order = 10;
22+
23+
public function getHelp()
24+
{
25+
return sprintf(
26+
'<p>%1$s</p><p>%2$s</p><p>%3$s</p>',
27+
Piwik::translate('AIAgents_AIAssistantsOverviewHelp1'),
28+
Piwik::translate('AIAgents_AIAssistantsOverviewHelp2'),
29+
Piwik::translate('AIAgents_AIAssistantsOverviewHelp3')
30+
);
31+
}
32+
}

‎plugins/AIAgents/lang/en.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
"AIAgentVisits": "AI Agent Visits",
55
"AIAgentVisitsDocumentation": "This is an overview of AI Agent visits.",
66
"AIAssistants": "AI Assistants",
7+
"AIAssistantsOverviewHelp1": "The AI Assistant Overview page provide insights into website traffic originating from AI Assistants such as ChatGPT and other large language model–based assistants. These reports track key metrics including the number of requests made by these bots, the pages and documents they access, and any errors encountered. They also offer detailed breakdowns showing which bots visit specific page URLs, helping you understand how AI assistants interact with your content and identify opportunities to improve visibility and accessibility for AI-driven users.",
8+
"AIAssistantsOverviewHelp2": "It’s important to note that none of these pages were actually viewed by humans in the traditional way — all requests originate from AI assistants fetching content automatically.",
9+
"AIAssistantsOverviewHelp3": "Currently, these reports exclusively include requests from AI bots that do not execute JavaScript. They do not include traffic from AI crawlers used for training AI models or from AI agents capable of executing JavaScript.",
710
"ColumnAIAgentActions": "Actions by AI Agent Visits",
811
"ColumnAIAgentAverageVisitDuration": "Avg. Duration of an AI Agent Visit (in sec)",
912
"ColumnAIAgentAvgActionsPerVisit": "Avg. Actions per AI Agent Visit",

‎tests/PHPUnit/System/expected/test_ImportLogs__PrivacyManager.getCompliancePolicies.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
<title>CNIL website analytics consent exemption conditions</title>
66
<description>This table provides an indication of whether certain settings align with CNIL guidance. It does not guarantee full legal compliance. To qualify for the consent exemption under CNIL rules, all required configurations must be implemented. If any setting is shown as “Non-Compliant,” the exemption conditions are not met, and consent must be obtained from users. If any setting is shown as “Unknown” Matomo cannot determine whether this requirement has been implemented. In such cases, these measures must be manually verified.</description>
77
</row>
8-
</result>
8+
</result>

‎tests/PHPUnit/System/expected/test_OneVisitorTwoVisits__PrivacyManager.getCompliancePolicies.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
<title>CNIL website analytics consent exemption conditions</title>
66
<description>This table provides an indication of whether certain settings align with CNIL guidance. It does not guarantee full legal compliance. To qualify for the consent exemption under CNIL rules, all required configurations must be implemented. If any setting is shown as “Non-Compliant,” the exemption conditions are not met, and consent must be obtained from users. If any setting is shown as “Unknown” Matomo cannot determine whether this requirement has been implemented. In such cases, these measures must be manually verified.</description>
77
</row>
8-
</result>
8+
</result>

‎tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getGlossaryReports.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@
7373
</row>
7474
<row>
7575
<name>Custom Variables (Visitors)</name>
76-
<documentation>This report contains information about your Custom Variables. Click on a variable name to see the distribution of the values. &lt;br /&gt; For more information about Custom Variables in general, read the &lt;a href="https://matomo.org/docs/custom-variables/" rel="noreferrer noopener" target="_blank"&gt;Custom Variables documentation on matomo.org&lt;/a&gt;</documentation>
76+
<documentation>This report contains information about your Custom Variables. Click on a variable name to see the distribution of the values. &lt;br /&gt; For more information about Custom Variables in general, read the &lt;a href=&quot;https://matomo.org/docs/custom-variables/&quot; rel=&quot;noreferrer noopener&quot; target=&quot;_blank&quot;&gt;Custom Variables documentation on matomo.org&lt;/a&gt;</documentation>
7777
<onlineGuideUrl>https://matomo.org/docs/custom-variables/</onlineGuideUrl>
7878
</row>
7979
<row>

‎tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getReportMetadata_day.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1242,7 +1242,7 @@
12421242
<module>CustomVariables</module>
12431243
<action>getCustomVariables</action>
12441244
<dimension>Custom Variable name</dimension>
1245-
<documentation>This report contains information about your Custom Variables. Click on a variable name to see the distribution of the values. &lt;br /&gt; For more information about Custom Variables in general, read the &lt;a href="https://matomo.org/docs/custom-variables/" rel="noreferrer noopener" target="_blank"&gt;Custom Variables documentation on matomo.org&lt;/a&gt;</documentation>
1245+
<documentation>This report contains information about your Custom Variables. Click on a variable name to see the distribution of the values. &lt;br /&gt; For more information about Custom Variables in general, read the &lt;a href=&quot;https://matomo.org/docs/custom-variables/&quot; rel=&quot;noreferrer noopener&quot; target=&quot;_blank&quot;&gt;Custom Variables documentation on matomo.org&lt;/a&gt;</documentation>
12461246
<onlineGuideUrl>https://matomo.org/docs/custom-variables/</onlineGuideUrl>
12471247
<dimensions>
12481248
<CustomVariables_CustomVariableName>Custom Variable name</CustomVariables_CustomVariableName>
@@ -3980,4 +3980,4 @@
39803980
<imageGraphEvolutionUrl>index.php?module=API&amp;method=ImageGraph.get&amp;idSite=1&amp;apiModule=API&amp;apiAction=get&amp;period=day&amp;date=2008-12-06,2009-01-04</imageGraphEvolutionUrl>
39813981
<uniqueId>API_get</uniqueId>
39823982
</row>
3983-
</result>
3983+
</result>

‎tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getReportPagesMetadata.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1376,7 +1376,7 @@
13761376
<id>CustomVariables_CustomVariables</id>
13771377
<name>Custom Variables</name>
13781378
<order>45</order>
1379-
<help>&lt;p&gt;This report contains information about your Custom Variables. Click on a variable name to see the distribution of the values.&lt;/p&gt;&lt;p&gt;&lt;a href="https://matomo.org/docs/custom-variables/" rel="noreferrer noopener" target="_blank"&gt;Read more about this topic in the online guide.&lt;/a&gt;&lt;/p&gt;</help>
1379+
<help>&lt;p&gt;This report contains information about your Custom Variables. Click on a variable name to see the distribution of the values.&lt;/p&gt;&lt;p&gt;&lt;a href=&quot;https://matomo.org/docs/custom-variables/&quot; rel=&quot;noreferrer noopener&quot; target=&quot;_blank&quot;&gt;Read more about this topic in the online guide.&lt;/a&gt;&lt;/p&gt;</help>
13801380
</subcategory>
13811381
<widgets>
13821382
<row>
@@ -6726,8 +6726,8 @@
67266726
<subcategory>
67276727
<id>General_Overview</id>
67286728
<name>Overview</name>
6729-
<order>99</order>
6730-
<help />
6729+
<order>10</order>
6730+
<help>&lt;p&gt;The AI Assistant Overview page provide insights into website traffic originating from AI Assistants such as ChatGPT and other large language model–based assistants. These reports track key metrics including the number of requests made by these bots, the pages and documents they access, and any errors encountered. They also offer detailed breakdowns showing which bots visit specific page URLs, helping you understand how AI assistants interact with your content and identify opportunities to improve visibility and accessibility for AI-driven users.&lt;/p&gt;&lt;p&gt;It’s important to note that none of these pages were actually viewed by humans in the traditional way — all requests originate from AI assistants fetching content automatically.&lt;/p&gt;&lt;p&gt;Currently, these reports exclusively include requests from AI bots that do not execute JavaScript. They do not include traffic from AI crawlers used for training AI models or from AI agents capable of executing JavaScript.&lt;/p&gt;</help>
67316731
</subcategory>
67326732
<widgets>
67336733
<row>
@@ -7023,4 +7023,4 @@
70237023
</row>
70247024
</widgets>
70257025
</row>
7026-
</result>
7026+
</result>

‎tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getWidgetMetadata.xml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -923,7 +923,7 @@
923923
<id>CustomVariables_CustomVariables</id>
924924
<name>Custom Variables</name>
925925
<order>45</order>
926-
<help>&lt;p&gt;This report contains information about your Custom Variables. Click on a variable name to see the distribution of the values.&lt;/p&gt;&lt;p&gt;&lt;a href="https://matomo.org/docs/custom-variables/" rel="noreferrer noopener" target="_blank"&gt;Read more about this topic in the online guide.&lt;/a&gt;&lt;/p&gt;</help>
926+
<help>&lt;p&gt;This report contains information about your Custom Variables. Click on a variable name to see the distribution of the values.&lt;/p&gt;&lt;p&gt;&lt;a href=&quot;https://matomo.org/docs/custom-variables/&quot; rel=&quot;noreferrer noopener&quot; target=&quot;_blank&quot;&gt;Read more about this topic in the online guide.&lt;/a&gt;&lt;/p&gt;</help>
927927
</subcategory>
928928
<module>CustomVariables</module>
929929
<action>getCustomVariables</action>
@@ -3661,8 +3661,8 @@
36613661
<subcategory>
36623662
<id>General_Overview</id>
36633663
<name>Overview</name>
3664-
<order>99</order>
3665-
<help />
3664+
<order>10</order>
3665+
<help>&lt;p&gt;The AI Assistant Overview page provide insights into website traffic originating from AI Assistants such as ChatGPT and other large language model–based assistants. These reports track key metrics including the number of requests made by these bots, the pages and documents they access, and any errors encountered. They also offer detailed breakdowns showing which bots visit specific page URLs, helping you understand how AI assistants interact with your content and identify opportunities to improve visibility and accessibility for AI-driven users.&lt;/p&gt;&lt;p&gt;It’s important to note that none of these pages were actually viewed by humans in the traditional way — all requests originate from AI assistants fetching content automatically.&lt;/p&gt;&lt;p&gt;Currently, these reports exclusively include requests from AI bots that do not execute JavaScript. They do not include traffic from AI crawlers used for training AI models or from AI agents capable of executing JavaScript.&lt;/p&gt;</help>
36663666
</subcategory>
36673667
<module>AIAgents</module>
36683668
<action>getEvolutionGraph</action>
@@ -3691,8 +3691,8 @@
36913691
<subcategory>
36923692
<id>General_Overview</id>
36933693
<name>Overview</name>
3694-
<order>99</order>
3695-
<help />
3694+
<order>10</order>
3695+
<help>&lt;p&gt;The AI Assistant Overview page provide insights into website traffic originating from AI Assistants such as ChatGPT and other large language model–based assistants. These reports track key metrics including the number of requests made by these bots, the pages and documents they access, and any errors encountered. They also offer detailed breakdowns showing which bots visit specific page URLs, helping you understand how AI assistants interact with your content and identify opportunities to improve visibility and accessibility for AI-driven users.&lt;/p&gt;&lt;p&gt;It’s important to note that none of these pages were actually viewed by humans in the traditional way — all requests originate from AI assistants fetching content automatically.&lt;/p&gt;&lt;p&gt;Currently, these reports exclusively include requests from AI bots that do not execute JavaScript. They do not include traffic from AI crawlers used for training AI models or from AI agents capable of executing JavaScript.&lt;/p&gt;</help>
36963696
</subcategory>
36973697
<module>AIAgents</module>
36983698
<action>get</action>

‎tests/PHPUnit/System/expected/test_noVisit_PeriodIsLast__PrivacyManager.getCompliancePolicies.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
<title>CNIL website analytics consent exemption conditions</title>
66
<description>This table provides an indication of whether certain settings align with CNIL guidance. It does not guarantee full legal compliance. To qualify for the consent exemption under CNIL rules, all required configurations must be implemented. If any setting is shown as “Non-Compliant,” the exemption conditions are not met, and consent must be obtained from users. If any setting is shown as “Unknown” Matomo cannot determine whether this requirement has been implemented. In such cases, these measures must be manually verified.</description>
77
</row>
8-
</result>
8+
</result>

‎tests/PHPUnit/System/expected/test_noVisit__PrivacyManager.getCompliancePolicies.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
<title>CNIL website analytics consent exemption conditions</title>
66
<description>This table provides an indication of whether certain settings align with CNIL guidance. It does not guarantee full legal compliance. To qualify for the consent exemption under CNIL rules, all required configurations must be implemented. If any setting is shown as “Non-Compliant,” the exemption conditions are not met, and consent must be obtained from users. If any setting is shown as “Unknown” Matomo cannot determine whether this requirement has been implemented. In such cases, these measures must be manually verified.</description>
77
</row>
8-
</result>
8+
</result>

0 commit comments

Comments
 (0)