Skip to content

Premium Analytics: add Stats email summary endpoint - #49900

Merged
kangzj merged 1 commit into
trunkfrom
endpoint/stats-email-summary-endpoint
Jun 29, 2026
Merged

Premium Analytics: add Stats email summary endpoint#49900
kangzj merged 1 commit into
trunkfrom
endpoint/stats-email-summary-endpoint

Conversation

@kangzj

@kangzj kangzj commented Jun 24, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Fixes #

Proposed changes

  • Add Premium Analytics data package support for the Stats email summary endpoint, following the Stats endpoint patterns established in Premium Analytics: add Stats endpoint foundation #49886.
  • Wire the endpoint-specific query, hook, public exports, and sanitizer/normalizer registration where applicable.
  • Keep endpoint typing tied to sanitizer keys or passthrough query inference, with focused fixtures/tests for the raw endpoint payload shape where normalization is introduced.

Related product discussion/links

Does this pull request change what data or activity we track or use?

No. This only adds typed client data/query integration for an existing Stats API endpoint.

Testing instructions

  • pnpm --dir projects/packages/premium-analytics test -- packages/data/src/queries/tests/stats-queries.test.ts packages/data/src/hooks/tests/stats-exports.test.ts --runInBand
  • pnpm exec eslint --max-warnings=0
  • pnpm --dir projects/packages/premium-analytics run typecheck
  • git diff --check

@kangzj
kangzj requested review from a team as code owners June 24, 2026 07:57
@kangzj kangzj added Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Feature] Stats Data Feature that enables users to track their site's traffic and gain insights on popular content. [Status] Needs Team Review Obsolete. Use Needs Review instead. [Package] Premium Analytics labels Jun 24, 2026
@kangzj kangzj self-assigned this Jun 24, 2026
@jp-launch-control

jp-launch-control Bot commented Jun 24, 2026 •
edited
Loading

Copy link
Copy Markdown

Code Coverage Summary

No summary data is available for parent commit 9e7d473, so cannot calculate coverage changes. 😴

If that commit is a feature branch rather than a trunk commit, this is expected. Otherwise, this should be updated once coverage for 9e7d473 is available.

Full summary · PHP report

@kangzj

This comment has been minimized.

Sign in to view
@claude

This comment has been minimized.

Sign in to view
@kangzj
kangzj force-pushed the endpoint/stats-email-summary-endpoint branch from a33aba5 to 3b53fd8 Compare June 24, 2026 08:28
@kangzj

This comment has been minimized.

Sign in to view
@claude

This comment has been minimized.

Sign in to view
@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

@kangzj

kangzj commented Jun 24, 2026

Copy link
Copy Markdown
Contributor Author

Review-cycle audit summary

No blocking reviewer feedback is open. Latest invited reviewer feedback is non-blocking, required checks report none for this branch, and the PR is ready with [Status] Needs Team Review.

Audit details
  • Branch: endpoint/stats-email-summary-endpoint
  • Base: endpoint/stats-endpoint-foundation
  • Head checked: 3b53fd8224c4cda694bbbdeefc6e2412b1dad0a0
  • Changes pushed during this audit: none
  • Addressable open comments: none
  • Unaddressed human comments: none
  • Required checks: none reported by GitHub

Base automatically changed from endpoint/stats-endpoint-foundation to trunk June 24, 2026 21:33
@kangzj
kangzj force-pushed the endpoint/stats-email-summary-endpoint branch 3 times, most recently from ac2e220 to f02060b Compare June 25, 2026 00:55
@kangzj
kangzj marked this pull request as draft June 25, 2026 09:01
@kangzj
kangzj force-pushed the endpoint/stats-email-summary-endpoint branch from c0ae17b to 4cdd612 Compare June 29, 2026 07:22
@kangzj
Premium Analytics: add Stats email summary endpoint
1a4512b 
Add data-package support for the WPCOM Stats email summary endpoint
(stats/emails/summary), following the established Stats endpoint patterns:
endpoint query, useStatsEmailSummary hook, public exports, and sanitizer
registration.

The query is modelled against the real endpoint contract rather than the
stale published docblock:

- It is an all-time report with no period parameter; only quantity, sort_field
  and sort_order are caller-controlled. sort_field is typed as the closed union
  the endpoint accepts (opens, clicks, post_id, post_date) and defaults to
  post_date to mirror the Calypso Emails screen.
- The raw fixture matches Email_Summary::build_response — all metrics as JSON
  numbers and the full post_date timestamp.

Covered by query-key and normalizer tests.
@kangzj
kangzj force-pushed the endpoint/stats-email-summary-endpoint branch from 4cdd612 to 1a4512b Compare June 29, 2026 07:26
@kangzj
kangzj marked this pull request as ready for review June 29, 2026 07:31
@kangzj kangzj mentioned this pull request Jun 29, 2026
Closed
@kangzj
kangzj merged commit 3ae31b4 into trunk Jun 29, 2026
71 of 72 checks passed
@kangzj
kangzj deleted the endpoint/stats-email-summary-endpoint branch June 29, 2026 08:15
@github-actions github-actions Bot removed [Status] In Progress [Status] Needs Team Review Obsolete. Use Needs Review instead. labels Jun 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@kangzj kangzj

Labels

Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Feature] Stats Data Feature that enables users to track their site's traffic and gain insights on popular content. [Package] Premium Analytics

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@kangzj