@adobe/spacecat-shared-rum-api-client 2.15.1 → 2.15.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +62 -24
  3. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,3 +1,17 @@
1
+ # [@adobe/spacecat-shared-rum-api-client-v2.15.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.15.2...@adobe/spacecat-shared-rum-api-client-v2.15.3) (2024-12-06)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * **cwv:** Update Core Web Vitals (CWV) in README to reflect newly added functionality. ([#473](https://github.com/adobe/spacecat-shared/issues/473)) ([617539a](https://github.com/adobe/spacecat-shared/commit/617539afe28f68b9c2e3cf9ad052863f6359a811))
7
+
8
+ # [@adobe/spacecat-shared-rum-api-client-v2.15.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.15.1...@adobe/spacecat-shared-rum-api-client-v2.15.2) (2024-12-06)
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * **deps:** update dependency @adobe/rum-distiller to v1.13.0 ([#476](https://github.com/adobe/spacecat-shared/issues/476)) ([842df52](https://github.com/adobe/spacecat-shared/commit/842df52872e4519bf1bd6931c5dc9f1d1f185dee)), closes [#8203](https://github.com/adobe/spacecat-shared/issues/8203)
14
+
1
15
  # [@adobe/spacecat-shared-rum-api-client-v2.15.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.15.0...@adobe/spacecat-shared-rum-api-client-v2.15.1) (2024-12-05)
2
16
 
3
17
 
package/README.md CHANGED
@@ -53,39 +53,77 @@ console.log(`Query result: ${result}`)
53
53
 
54
54
  ## Available queries
55
55
 
56
- ### cwv
56
+ ### Core Web Vitals (CWV)
57
57
 
58
- Calculates the CWV data for a given domain within the requested interval. It gets the
59
- P75 values for LCP, CLS, INP, TTFB metrics, along with the number of data points available for
60
- each metric. Additionally, it provides grouping by URL and includes the count of page view data.
58
+ Calculates the CWV data for a given domain within the requested interval. It retrieves the P75
59
+ values for **LCP**, **CLS**, **INP**, and **TTFB** metrics, along with the number of data points available for
60
+ each metric.
61
+
62
+ Additionally:
63
+
64
+ - Metrics are **grouped by URL** and by **patterns** for groups of URLs, providing flexibility in analysis for both individual pages and logical collections of pages.
65
+ - Includes a **device-level breakdown**, categorizing metrics separately for **desktop** and **mobile**.
66
+ - Provides **page view counts** (pageviews) and **organic traffic** (organic) metrics, offering insights into user activity and search-driven traffic.
61
67
 
62
68
  An example response:
63
69
 
64
70
  ```json
65
71
  [
66
72
  {
67
- "url": "https://www.aem.live/home",
68
- "pageviews": 2620,
69
- "lcp": 2099.699999988079,
70
- "lcpCount": 9,
71
- "cls": 0.020660136604802475,
72
- "clsCount": 7,
73
- "inp": 12,
74
- "inpCount": 3,
75
- "ttfb": 520.4500000476837,
76
- "ttfbCount": 18
73
+ "type": "group",
74
+ "name": "Catalog",
75
+ "pattern": "https://www.aem.live/docs/*",
76
+ "pageviews": 12000,
77
+ "organic": 4000,
78
+ "metrics": [
79
+ {
80
+ "deviceType": "desktop",
81
+ "pageviews": 8000,
82
+ "organic": 3000,
83
+ "lcp": 40,
84
+ "lcpCount": 6,
85
+ "cls": 0.3,
86
+ "clsCount": 3,
87
+ "inp": 30,
88
+ "inpCount": 3,
89
+ "ttfb": 30,
90
+ "ttfbCount": 3
91
+ },
92
+ {
93
+ "deviceType": "mobile",
94
+ "pageviews": 1000,
95
+ "organic": 200,
96
+ "lcp": 40,
97
+ "lcpCount": 6,
98
+ "cls": 0.3,
99
+ "clsCount": 3,
100
+ "inp": 30,
101
+ "inpCount": 3,
102
+ "ttfb": 30,
103
+ "ttfbCount": 3
104
+ }
105
+ ]
77
106
  },
78
107
  {
79
- "url": "https://www.aem.live/developer/block-collection",
80
- "pageviews": 2000,
81
- "lcp": 512.1249999403954,
82
- "lcpCount": 4,
83
- "cls": 0.0005409526209424976,
84
- "clsCount": 4,
85
- "inp": 20,
86
- "inpCount": 2,
87
- "ttfb": 122.90000003576279,
88
- "ttfbCount": 4
108
+ "type": "url",
109
+ "url": "https://www.aem.live/home",
110
+ "pageviews": 2620,
111
+ "organic": 1900,
112
+ "metrics": [
113
+ {
114
+ "deviceType": "desktop",
115
+ "pageviews": 2420,
116
+ "organic": 1700,
117
+ "lcp": 2099.699999988079,
118
+ "lcpCount": 8,
119
+ "cls": 0.011145537287059668,
120
+ "clsCount": 7,
121
+ "inp": 8,
122
+ "inpCount": 5,
123
+ "ttfb": 548,
124
+ "ttfbCount": 16
125
+ }
126
+ ]
89
127
  }
90
128
  ]
91
129
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adobe/spacecat-shared-rum-api-client",
3
- "version": "2.15.1",
3
+ "version": "2.15.3",
4
4
  "description": "Shared modules of the Spacecat Services - Rum API client",
5
5
  "type": "module",
6
6
  "engines": {
@@ -39,7 +39,7 @@
39
39
  "@adobe/helix-shared-wrap": "2.0.2",
40
40
  "@adobe/helix-universal": "5.0.7",
41
41
  "@adobe/spacecat-shared-utils": "1.22.4",
42
- "@adobe/rum-distiller": "1.12.0",
42
+ "@adobe/rum-distiller": "1.13.0",
43
43
  "aws4": "1.13.2",
44
44
  "urijs": "^1.19.11"
45
45
  },