feat: Include site level metrics in the CWV response (#615)

adobe · Dec 6, 2024 · 803081f · 803081f
1 parent dcee266
commit 803081f
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/openapi/schemas.yaml b/docs/openapi/schemas.yaml
@@ -1765,6 +1765,7 @@ Opportunity:
       additionalProperties: true
       oneOf:
         - $ref: '#/BrokenBacklinksOpportunityData'
+        - $ref: '#/CWVOpportunityData'
     origin:
       $ref: '#/OpportunityOrigin'
     title:
@@ -1784,6 +1785,7 @@ Opportunity:
       additionalProperties: true
       oneOf:
         - $ref: '#/BrokenBacklinksGuidance'
+        - $ref: '#/CWVGuidance'
     tags:
       type: array
       items:
@@ -2212,3 +2214,24 @@ ImportJobStopRequest:
       type: string
       enum:
         - 'STOPPED'
+CWVOpportunityData:
+  description: Data specific to Core Web Vitals improvements opportunity
+  type: object
+  properties:
+    projectedTrafficLost:
+      type: number
+      description: Projected Traffic Lost, representing the estimated loss of organic traffic
+    projectedTrafficValue:
+      type: number
+      description: Projected Traffic Value, calculated by multiplying the Projected Traffic Lost by the Cost Per Click (CPC) value.
+  additionalProperties: true
+CWVGuidance:
+  description: Guidance specific to Core Web Vitals improvements opportunity
+  type: object
+  additionalProperties: true
+  properties:
+    steps:
+      description: The recommended steps to resolve Core Web Vitals issues and improve site performance.
+      type: array
+      items:
+        type: string