Analytics: send ?status to the backend (#626)

humitos · web-flow · commit c8f5d7cd7a94 · 2025-07-29T11:24:59.000+02:00
Required by readthedocs/readthedocs.org#12307
diff --git a/src/analytics.js b/src/analytics.js
@@ -3,7 +3,8 @@
 import { default as fetch } from "unfetch";
 
 import { ajv } from "./data-validation";
-import { AddonBase, CLIENT_VERSION } from "./utils";
+import { AddonBase, getMetadataValue, CLIENT_VERSION } from "./utils";
+import { default as objectPath } from "object-path";
 
 export const API_ENDPOINT = "/_/api/v2/analytics/";
 
@@ -29,17 +30,32 @@ export class AnalyticsAddon extends AddonBase {
   loadConfig(config) {
     this.config = config;
 
-    // Only register pageviews on non-external versions
-    if (this.config.versions.current.type !== "external") {
-      this.registerPageView();
+    const versionType = objectPath.get(
+      this.config,
+      "versions.current.type",
+      null,
+    );
+
+    // Don't register pageviews on external versions
+    if (versionType === "external") {
+      return;
     }
+
+    this.registerPageView();
   }
 
   registerPageView() {
+    const httpStatus = getMetadataValue("readthedocs-http-status");
+    const versionSlug = objectPath.get(
+      this.config,
+      "versions.current.slug",
+      null,
+    );
     const params = {
       project: this.config.projects.current.slug,
-      version: this.config.versions.current.slug,
+      version: versionSlug,
       absolute_uri: window.location.href,
+      status: httpStatus,
     };
 
     const url = API_ENDPOINT + "?" + new URLSearchParams(params).toString();
diff --git a/src/data-validation.js b/src/data-validation.js
@@ -48,20 +48,6 @@ const addons_analytics = {
         },
       },
     },
-    versions: {
-      type: "object",
-      required: ["current"],
-      properties: {
-        current: {
-          type: "object",
-          required: ["slug", "type"],
-          properties: {
-            slug: { type: "string" },
-            type: { type: "string" },
-          },
-        },
-      },
-    },
   },
 };
 
diff --git a/tests/analytics.test.html b/tests/analytics.test.html
@@ -1,4 +1,7 @@
 <html>
+  <head>
+    <meta name="readthedocs-http-status" content="200" />
+  </head>
   <body>
     <script type="module">
       import { default as sinon } from "sinon";
@@ -71,6 +74,7 @@
               project: "project",
               version: "version",
               absolute_uri: window.location.href,
+              status: 200,
             };
 
             const url =
