ADD: Add progress to BatchJob response

Author: threecgreen

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.51.0 - TBD
+
+### Enhancements
+- Added support for `progress` field in `BatchJob` response
+
 ## 0.50.0 - 2026-03-03
 
 ### Enhancements

include/databento/batch.hpp

@@ -1,6 +1,7 @@
 #pragma once
 
 #include <cstdint>
+#include <optional>
 #include <ostream>
 #include <string>
 #include <vector>
@@ -49,6 +50,8 @@ struct BatchJob {
   // Empty if it hasn't finished processing. The expiration is set based on when
   // the job finishes processing, not when it was requested.
   std::string ts_expiration;
+  // Progress percentage (0-100). `nullopt` for jobs that were just submitted.
+  std::optional<std::uint8_t> progress;
 };
 
 // Description of a batch file.

include/databento/detail/json_helpers.hpp

@@ -93,5 +93,8 @@ std::vector<std::string> ParseAt(std::string_view endpoint, const nlohmann::json
 template <>
 date::year_month_day ParseAt(std::string_view endpoint, const nlohmann::json& json,
                              std::string_view key);
+template <>
+std::optional<std::uint8_t> ParseAt(std::string_view endpoint,
+                                    const nlohmann::json& json, std::string_view key);
 
 }  // namespace databento::detail

src/batch.cpp

@@ -47,6 +47,7 @@ std::ostream& operator<<(std::ostream& stream, const BatchJob& batch_job) {
       .AddField("ts_process_start", batch_job.ts_process_start)
       .AddField("ts_process_done", batch_job.ts_process_done)
       .AddField("ts_expiration", batch_job.ts_expiration)
+      .AddField("progress", batch_job.progress)
       .Finish();
 }
 

src/detail/json_helpers.cpp

@@ -138,4 +138,20 @@ date::year_month_day ParseAt(std::string_view endpoint, const nlohmann::json& js
   }
   return start;
 }
+template <>
+std::optional<std::uint8_t> ParseAt(std::string_view endpoint,
+                                    const nlohmann::json& json, std::string_view key) {
+  if (!json.contains(key)) {
+    return {};
+  }
+  const auto& val_json = json.at(key);
+  if (val_json.is_null()) {
+    return {};
+  }
+  if (!val_json.is_number_unsigned()) {
+    throw JsonResponseError::TypeMismatch(
+        endpoint, std::string{key} + " unsigned number", val_json);
+  }
+  return val_json.get<std::uint8_t>();
+}
 }  // namespace databento::detail

src/historical.cpp

@@ -104,6 +104,7 @@ databento::BatchJob Parse(const std::string& endpoint, const nlohmann::json& jso
   res.ts_process_start = ParseAt<std::string>(endpoint, json, "ts_process_start");
   res.ts_process_done = ParseAt<std::string>(endpoint, json, "ts_process_done");
   res.ts_expiration = ParseAt<std::string>(endpoint, json, "ts_expiration");
+  res.progress = ParseAt<std::optional<std::uint8_t>>(endpoint, json, "progress");
   return res;
 }
 

tests/src/batch_tests.cpp

@@ -35,7 +35,8 @@ TEST(BatchTests, TestBatchJobToString) {
                         {},
                         {},
                         {},
-                        {}};
+                        {},
+                        std::optional<std::uint8_t>{50}};
   const auto res = ToString(target);
   ASSERT_EQ(res, R"(BatchJob {
     id = "AN_ID",
@@ -67,7 +68,8 @@ TEST(BatchTests, TestBatchJobToString) {
     ts_queued = "",
     ts_process_start = "",
     ts_process_done = "",
-    ts_expiration = ""
+    ts_expiration = "",
+    progress = 50
 })");
 }
 }  // namespace databento::tests