New Stats #843

kean · 2025-07-18T18:39:31Z

New Features

Email Opens Stats: Added support for fetching email opens statistics with new StatsEmailOpensData model
Archive Stats: Introduced StatsArchiveTimeIntervalData for generalized archive endpoint parsing
Hourly Stats Support: Added StatsPeriodUnit.hour to enable hourly statistics data
Site Metrics: Added StatsSiteMetricsResponse for improved site metrics handling

API Enhancements

Extended StatsServiceRemoteV2.getData with startDate, timeZone, and fields parameters
Added summarize parameter support for stats requests
Enhanced StatsPostDetails to include all available data fields

….getData

dangermattic · 2025-07-18T19:54:09Z

	2 Warnings
⚠️	`Package.swift` was changed without updating its corresponding `Package.resolved`. Please resolve the Swift packages as appropriate to your project setup (e.g. in Xcode or by running `swift package resolve`).
⚠️	This PR is larger than 300 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.

Generated by 🚫 Danger

crazytonyli · 2025-07-31T23:22:52Z

Sources/WordPressKit/Models/Stats/Emails/StatsEmailOpensData.swift

+        uniqueOpens = try container.decodeIfPresent(Int.self, forKey: .uniqueOpens)
+        totalOpens = try container.decodeIfPresent(Int.self, forKey: .totalOpens)
+        opensRate = try container.decodeIfPresent(Double.self, forKey: .opensRate)
+    }


Do we need this function? It's the same as the default derived implementation, if I'm not mistaken?

No really - removing.

crazytonyli · 2025-07-31T23:23:46Z

Sources/WordPressKit/Models/Stats/Emails/StatsEmailOpensData.swift

+}
+
+extension StatsEmailOpensData {
+    public init?(jsonDictionary: [String: AnyObject]) {


throw instead of silencing the error?

I auto-generated this code with the rest of the file as a reference. It is consistent with the rest of StatsServiceRemoteV2 and how it's used. I'd suggest keeping it as it's throw-away code anyway.

crazytonyli · 2025-07-31T23:36:58Z

Sources/WordPressKit/Models/Stats/Emails/StatsEmailOpensData.swift

+    public let totalSends: Int?
+    public let uniqueOpens: Int?
+    public let totalOpens: Int?
+    public let opensRate: Double?


Should all these properties be null? Will the response ever be null, like no total_sends or total_send: null in the response?

I'd change it, but it's a throw-away code, so I'm not sure it's worth reworking it and the usage. I'm not sure I have any energy left at this point 😪

crazytonyli · 2025-07-31T23:39:09Z

Sources/WordPressKit/Models/Stats/StatsSubscribersSummaryData.swift


+    static var hourlyDateFormatter: DateFormatter {
+        let df = DateFormatter()
+        df.locale = Locale(identifier: "en_US_POS")


Is the id supposed to be en_US_POSIX?

Updated. This code is unused – the new stats don't request hourly data for subscribers and there is no hourly data for subscribers. The existing formatters in this screen use en_US_POS. I didn't want to make changes to the existing code in the scope of this change.

crazytonyli · 2025-07-31T23:47:01Z

Sources/WordPressKit/Models/Stats/Time Interval/StatsSiteMetricsResponse.swift

+        let dateFormatter = makeDateFormatter(for: period)
+
+        self.data = data.compactMap { data in
+            guard let periodDate = dateFormatter.date(from: data[periodIndex] as? String ?? "") else {


Nitpick:

Suggested change

guard let periodDate = dateFormatter.date(from: data[periodIndex] as? String ?? "") else {

guard let date = data[periodIndex] as? String, let periodDate = dateFormatter.date(from: date) else {

crazytonyli · 2025-07-31T23:55:08Z

Sources/WordPressKit/Models/Stats/StatsPostDetails.swift

+
+            let dateFormatter = DateFormatter()
+            dateFormatter.locale = Locale(identifier: "en_US_POSIX")
+            dateFormatter.dateFormat = "yyyy-MM-dd HH:mm:ss"


You'd need to set the timeZone property to parse GMT date strings that do not have a time zone in them, right?

This is an existing issue across all existing decodes in this service. The date is actually returned in the site time zone. The decoders don't know what is the time zone of the site. The response also doesn't contain it. So it end's up creating a wrong timestamp in your local time zone.

I added code to map it in StatsService https://github.com/wordpress-mobile/WordPress-iOS/blob/b82374372485a73d0a3f49bc5cbc3886a3179767/Modules/Sources/JetpackStats/Services/StatsService.swift#L355, but I think I made a mistake at one of the layers. I opened a ticket and will debug it later on Monday: https://linear.app/a8c/issue/CMM-642/dates-are-in-the-wrong-timezone. The fix needs to be on the app level. I want to keep the WPKit behavior as is so it doesn't break the legacy screens.

crazytonyli · 2025-07-31T23:59:20Z

Sources/WordPressKit/Services/StatsServiceRemoteV2.swift

+        var staticProperties = ["period": period.stringValue,
                                "unit": unit?.stringValue ?? period.stringValue,
-                                "date": periodDataQueryDateFormatter.string(from: endingOn)] as [String: AnyObject]
+                                "date": dateFormatter.string(from: endingOn)] as [String: AnyObject]


Nitpick: I think you can get rid of all the as statements below if you declare the staticProperties as [String: Any].

Yeah, it support Any, but I just didn't want to change it since it's the existing code. There was already too many changes, and I wanted to keep the changes to the existing code minimum.

crazytonyli · 2025-08-01T00:02:04Z

Sources/WordPressKit/Services/StatsServiceRemoteV2.swift

+// MARK: - Email Opens
+
+public extension StatsServiceRemoteV2 {
+    func getEmailOpens(for postID: Int, completion: @escaping ((StatsEmailOpensData?, Error?) -> Void)) {


What do you think about using async functions instead of calls for the new API calls? I presume the callers are written in Swift too, which may prefer async functions?

crazytonyli · 2025-08-01T00:09:24Z

Sources/WordPressKit/Models/Stats/Time Interval/StatsSiteMetricsResponse.swift

+            posts: fields.firstIndex(of: Metric.posts.rawValue)
+        )
+
+        let dateFormatter = makeDateFormatter(for: period)


There is this comment above: "/// Periods date in the site timezone."

It's impossible to parse a date string if we don't know what the site timezone is, right? So, it's incorrect to use any DateFormatter instance. I think the correct solution is either passing the site timezone from the app¹ to the parsing function here, or returning a plain string and letting the app parse it.

Footnotes

Or, making another HTTP request to get site timezone, which does feel like wasteful. ↩

I'll revisit this in the scope of #843 (comment). The app knows the time zone, so it will need to perform the conversion.

In reality, StatsServiceRemoteV2 simply uses incorrect types to represent dates. If It doesn't know what time zone the dates component belong to, it should never returned Date (timestamp). It ends up always creating wrong time stamps (in your app current time zone instead of the site time zone). Unfortunately, it is what it is.

crazytonyli · 2025-08-01T00:11:11Z

There are merge conflicts and failing unit tests.

kean · 2025-08-04T17:12:49Z

I merged trunk, recompiled the framework, and the tests are now successful. Looks like it was related to the SwiftLint changes.

kean added 5 commits July 18, 2025 14:24

Add startDate, timeZone, and fields parameter to SattsServiceRemoteV2…

58092a4

….getData

Add StatsPeriodUnit.hour

8ad283d

Revert some of the changes

8c33cf7

Fix release build error

b17f5d8

Update build

ca75e34

kean mentioned this pull request Jul 18, 2025

Feature: New Stats wordpress-mobile/WordPress-iOS#24677

Merged

kean added 6 commits July 19, 2025 10:52

Fix parsing for hourly data

064b128

Fetch post counts

5704cbb

Update build

e146c87

make values in StatsSummaryData optional (they are for hourly data)

7e76969

Update build

8bf6082

Add new StatsSiteStats to avoid changing previous APIs

0a0dac0

kean force-pushed the task/new-stats branch from 4fa9491 to 84eb859 Compare July 19, 2025 19:18

Rename StatsSiteMetricsResponse and make Metric public

9139c2f

kean force-pushed the task/new-stats branch from 84eb859 to 9139c2f Compare July 20, 2025 14:39

Pass period

102dc8d

kean force-pushed the task/new-stats branch from f29697a to 99ebbc8 Compare July 21, 2025 17:57

Add summarize param

392d2d3

kean force-pushed the task/new-stats branch from 99ebbc8 to 392d2d3 Compare July 21, 2025 18:21

kean added 2 commits July 22, 2025 13:04

Add initial StatsArchiveTimeIntervalData

a8b31bc

Extend StatsPostDetails

32f9410

kean force-pushed the task/new-stats branch from 9c20c99 to 32f9410 Compare July 22, 2025 19:17

kean added 5 commits July 22, 2025 15:18

Fix SwiftLint warnings

6588ca8

Add all data to StatsPostDetails

c31ddf1

Generalized Archive endpoint parser

2613f21

Fix StatsPeriodUnit crash

67db92e

Add endpoint to fetch stats emails

c78d1f2

kean requested a review from crazytonyli July 30, 2025 22:58

crazytonyli reviewed Aug 1, 2025

View reviewed changes

kean added 3 commits August 1, 2025 17:54

Remove unused StatsEmailOpensData

1b4d284

Update

1e06e95

Merge trunk

440d94e

kean requested a review from crazytonyli August 4, 2025 17:12

crazytonyli approved these changes Aug 4, 2025

View reviewed changes

kean merged commit 7d8c756 into trunk Aug 5, 2025
7 checks passed

kean deleted the task/new-stats branch August 5, 2025 18:29

	guard let periodDate = dateFormatter.date(from: data[periodIndex] as? String ?? "") else {
	guard let date = data[periodIndex] as? String, let periodDate = dateFormatter.date(from: date) else {

New Stats #843

New Stats #843

Uh oh!

Conversation

kean commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Features

API Enhancements

Uh oh!

dangermattic commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kean Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Footnotes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

crazytonyli commented Aug 1, 2025

Uh oh!

kean commented Aug 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kean commented Jul 18, 2025 •

edited

Loading

dangermattic commented Jul 18, 2025 •

edited

Loading

kean Aug 1, 2025 •

edited

Loading