Skip to content

Docs: email statistics, the statistics:read scope names, the sending type changed event, CLI v0.5.0 - #62

Merged
farhadhf merged 1 commit into
mainfrom
docs/november-release
Nov 11, 2026
Merged

farhadhf merged 1 commit into
mainfrom
docs/november-release

Conversation

@farhadhf

Copy link
Copy Markdown
Contributor

Summary

 openapi.yaml, webhooks.yaml          # copied from the server
+api-reference/reports/get-email-statistics.mdx
+api-reference/webhooks/domain-sending_type_changed.mdx
 api-reference/scopes.mdx …           # statistics:read:all / statistics:read:{domain}; earlier names still work
 cli/commands/stats.mdx               # stats emails
 cli/commands/webhooks.mdx …          # sending_type_changed event (14 / 22 events)
 cli/installation.mdx, scripts/, CI   # CLI v0.5.0
 guides/go-sdk.mdx, nodejs-sdk.mdx    # email statistics methods
 api-reference/rate-limits.mdx …      # 1 req/s is for the transactional statistics only
 changelog.mdx                        # November 2026 items

The changelog says that a key saved in the dashboard returns its statistics scopes under the new names, so a tool that compares scopes shows a difference once.

Evidence

  • Before: the docs name the old scope names only and do not have the email statistics endpoint, the new event or CLI v0.5.0.
    After: capture_cli, docs_lint, validate_schema, mint validate, mint broken-links and test_docs_checks (36/36) pass with CLI v0.5.0. Both spec files are byte-identical to the server's.

Merge Danger

Door: two-way

Blast Radius: docs

…type changed event, CLI v0.5.0

Copies the API and webhook specs from the server and brings the pages in
line with what is released: Get Email Statistics, the statistics scopes
under their new names (the earlier names keep working), the
domain.sending_type_changed webhook event, CLI v0.5.0 with stats emails,
the SDK versions 0.8.0 and the MCP server. The docs checks pin CLI
v0.5.0. The 1 request per second limit is named for the transactional
statistics only, because the email statistics endpoint has the general
limit.
@farhadhf
farhadhf merged commit 313feac into main Nov 11, 2026
2 checks passed
@farhadhf
farhadhf deleted the docs/november-release branch November 11, 2026 22:53
MarkNLD added a commit that referenced this pull request Nov 12, 2026
Brings in the email statistics docs, the sending type changed event
and CLI v0.5.0 (#62) and the two docs commits after it. Four files
conflicted on heading lines only; they take main's text, and the next
commit puts their headings in sentence case.
MarkNLD added a commit that referenced this pull request Nov 12, 2026
55 headings in 6 files: the four files that took main's text in the
merge and the two new pages from #62. Letter case only.
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.

1 participant