Update the browser API protocol doc (#12619)

apache · Jan 7, 2025 · 09965ab · 09965ab
1 parent 844aa50
commit 09965ab
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 1 deletion.
diff --git a/docs/en/api/browser-http-api-protocol.md b/docs/en/api/browser-http-api-protocol.md
@@ -31,7 +31,69 @@ Input:
   "sslTime": 10,
   "ttlTime": 10,
   "firstPackTime": 10,
-  "fmpTime": 10
+}
+```
+
+OutPut:
+
+Http Status: 204
+
+### POST http://localhost:12800/browser/perfData/webVitals
+
+Send a performance data object in JSON format. Since client-js 1.0.0, the following attached metrics are reported.
+
+Input:
+
+```json
+{
+  "service": "web",
+  "serviceVersion": "v0.0.1",
+  "pagePath": "/index.html",
+  "fmpTime": 10,
+  "clsTime": 10,
+  "lcpTime": 10,
+}
+```
+
+OutPut:
+
+Http Status: 204
+
+### POST http://localhost:12800/browser/perfData/webInteraction
+
+Send a performance data object in JSON format. Since client-js 1.0.0, the following attached metrics are reported.
+
+Input:
+
+```json
+{
+  "service": "web",
+  "serviceVersion": "v0.0.1",
+  "pagePath": "/index.html",
+  "fidTime": 10,
+}
+```
+
+OutPut:
+
+Http Status: 204
+
+### POST http://localhost:12800/browser/perfData/resources
+
+Send a static resources data object in JSON format. Since client-js 1.0.0, the following attached metrics are reported.
+
+Input:
+
+```json
+{
+  "service": "web",
+  "serviceVersion": "v0.0.1",
+  "pagePath": "/index.html",
+  "name": "vue.js",
+  "duration": 600,
+  "size": 100000,
+  "protocol": "h2",
+  "type": "script",
 }
 ```
 

diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
@@ -84,4 +84,6 @@
 * Add Status APIs docs.
 * Simplified the release process with removing maven central publish relative processes.
 
+
 All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/224?closed=1)
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -84,4 +84,6 @@
		* Add Status APIs docs.
		* Simplified the release process with removing maven central publish relative processes.


		All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/224?closed=1)