Skip to content

[GG-2099] Document limit for email metrics - #144

Open
wstrinz wants to merge 1 commit into
mainfrom
GG-2099-email-metrics-limit-docs
Open

wstrinz wants to merge 1 commit into
mainfrom
GG-2099-email-metrics-limit-docs

Conversation

@wstrinz

@wstrinz wstrinz commented Nov 2, 2026

Copy link
Copy Markdown

Part of: https://dripcom.atlassian.net/browse/GG-2099

Documents changes here:

Documents the limit argument on fetching email metrics (default 100, 1 to 1,000), the new emails_total and emails_truncated response fields, and that emails is ordered by sends, highest first.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The linked implementation PR returned 404, leaving the documented limit validation, tie-breaking order, and response semantics unverified until a reviewer with access can check them.

No open issues 🎉

What changed in this PR

Updates the REST API documentation to describe result limits and response metadata for fetching email metrics.

Changes:

  • Documents limit with a default of 100 and an allowed range of 1–1,000, without affecting summary totals.
  • Adds emails_total and emails_truncated to response examples and explains truncation.
  • Clarifies ordering by sends descending, then email_id ascending, and the lack of pagination.
File Description
source/​includes/​rest/​_metrics.md Documents email metric limits, response metadata, ordering, and retrieval constraints.

Review effort: Balanced

@wstrinz
wstrinz marked this pull request as ready for review November 2, 2026 19:04
@wstrinz
wstrinz requested a review from a team November 2, 2026 19:04

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants