audits endpoint

Author: max-ostapenko

README.md

@@ -174,9 +174,9 @@ Lists available versions.
 
 #### Versions Parameters
 
-- `version` (optional): Filter by version name(s) - comma-separated list
 - `technology` (optional): Filter by technology name(s) - comma-separated list
 - `category` (optional): Filter by category - comma-separated list
+- `version` (optional): Filter by version name(s) - comma-separated list
 - `onlyname` (optional): If present, returns only version names
 - `fields` (optional): Comma-separated list of fields to include in the response (see [Field Selection API Documentation](#field-selection-api-documentation) for details)
 
@@ -209,10 +209,10 @@ Provides technology adoption data.
 #### Adoption Parameters
 
 - `technology` (required): Filter by technology name(s) - comma-separated list
+- `geo` (required): Filter by geographic location
+- `rank` (required): Filter by rank
 - `start` (optional): Filter by date range start (YYYY-MM-DD or 'latest')
 - `end` (optional): Filter by date range end (YYYY-MM-DD)
-- `geo` (optional): Filter by geographic location
-- `rank` (optional): Filter by rank
 
 #### Adoption Response
 
@@ -334,8 +334,8 @@ Provides Page Weight metrics for technologies.
 #### Page Weight Parameters
 
 - `technology` (required): Filter by technology name(s) - comma-separated list
-- `geo` (optional): Filter by geographic location
-- `rank` (optional): Filter by rank
+- `geo` (required): Filter by geographic location
+- `rank` (required): Filter by rank
 - `start` (optional): Filter by date range start (YYYY-MM-DD or 'latest')
 - `end` (optional): Filter by date range end (YYYY-MM-DD)
 
@@ -387,6 +387,70 @@ Returns a JSON object with the following schema:
 ]
 ```
 
+
+### `GET /audits`
+
+Provides Lighthouse audits for technologies.
+
+#### Audits Parameters
+
+- `technology` (required): Filter by technology name(s) - comma-separated list
+- `geo` (required): Filter by geographic location
+- `rank` (required): Filter by rank
+- `start` (optional): Filter by date range start (YYYY-MM-DD or 'latest')
+- `end` (optional): Filter by date range end (YYYY-MM-DD)
+
+#### Audits Response
+
+```bash
+curl --request GET \
+  --url 'https://{{HOST}}/v1/audits?start=latest&geo=ALL&technology=WordPress&rank=ALL'
+```
+
+Returns a JSON object with the following schema:
+
+```json
+[
+    {
+        "date": "2025-06-01",
+        "audits": [
+            {
+                "desktop": {
+                    "pass_origins": 2428028
+                },
+                "mobile": {
+                    "pass_origins": 2430912
+                },
+                "id": "first-contentful-paint",
+                "category": "performance"
+            },
+            {
+                "desktop": {
+                    "pass_origins": 490451
+                },
+                "mobile": {
+                    "pass_origins": 477218
+                },
+                "id": "largest-contentful-paint",
+                "category": "performance"
+            },
+            {
+                "desktop": {
+                    "pass_origins": 1221876
+                },
+                "mobile": {
+                    "pass_origins": 1296673
+                },
+                "id": "cumulative-layout-shift",
+                "category": "performance"
+            }
+        ],
+        "technology": "WordPress"
+    },
+    ...
+]
+```
+
 ### `GET /ranks`
 
 Lists all available ranks.

src/controllers/reportController.js

@@ -32,6 +32,10 @@ const REPORT_CONFIGS = {
     cwv: {
         table: 'core_web_vitals',
         dataField: 'vitals'
+    },
+    audits: {
+        table: 'audits',
+        dataField: 'audits'
     }
 };
 
@@ -146,7 +150,10 @@ const createReportController = (reportType) => {
 };
 
 // Export individual controller functions
+export const listAuditsData = createReportController('audits');
 export const listAdoptionData = createReportController('adoption');
-export const listPageWeightData = createReportController('pageWeight');
-export const listLighthouseData = createReportController('lighthouse');
 export const listCWVTechData = createReportController('cwv');
+export const listLighthouseData = createReportController('lighthouse');
+export const listPageWeightData = createReportController('pageWeight');
+
+

src/index.js

@@ -11,6 +11,7 @@ const controllers = {
   cwvtech: null,
   lighthouse: null,
   pageWeight: null,
+  audits: null,
   ranks: null,
   geos: null,
   versions: null
@@ -30,6 +31,7 @@ const getController = async (name) => {
       case 'cwvtech':
       case 'lighthouse':
       case 'pageWeight':
+      case 'audits':
         controllers[name] = await import('./controllers/reportController.js');
         break;
       case 'ranks':
@@ -144,6 +146,9 @@ const handleRequest = async (req, res) => {
     } else if (pathname === '/v1/page-weight' && req.method === 'GET') {
       const { listPageWeightData } = await getController('pageWeight');
       await listPageWeightData(req, res);
+    } else if (pathname === '/v1/audits' && req.method === 'GET') {
+      const { listAuditsData } = await getController('audits');
+      await listAuditsData(req, res);
     } else if (pathname === '/v1/ranks' && req.method === 'GET') {
       const { listRanks } = await getController('ranks');
       await listRanks(req, res);

terraform/modules/run-service/main.tf

@@ -1,5 +1,5 @@
 locals {
-  bucketName = "tf-cloudfunctions-backingapi-20230314"
+  bucketName = "gcf-v2-uploads-226352634162-us-central1"
 }
 data "archive_file" "source" {
   type        = "zip"

test-api.sh

@@ -113,4 +113,7 @@ test_endpoint "/v1/lighthouse" "?technology=WordPress&geo=ALL&rank=ALL&start=lat
 # Test page-weight endpoint
 test_endpoint "/v1/page-weight" "?technology=WordPress&geo=ALL&rank=ALL&start=latest"
 
+# Test audits endpoint
+test_endpoint "/v1/audits" "?technology=WordPress&geo=ALL&rank=ALL&start=latest"
+
 echo "API tests complete! All endpoints returned 200 status code and CORS is properly configured."