Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/index.html

Large diffs are not rendered by default.

23 changes: 23 additions & 0 deletions docs/openapi/schemas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1765,6 +1765,7 @@ Opportunity:
additionalProperties: true
oneOf:
- $ref: '#/BrokenBacklinksOpportunityData'
- $ref: '#/CWVOpportunityData'
origin:
$ref: '#/OpportunityOrigin'
title:
Expand All @@ -1784,6 +1785,7 @@ Opportunity:
additionalProperties: true
oneOf:
- $ref: '#/BrokenBacklinksGuidance'
- $ref: '#/CWVGuidance'
tags:
type: array
items:
Expand Down Expand Up @@ -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
Loading