Add Email Metrics API docs partial#125
Draft
wstrinz wants to merge 1 commit into
Draft
Conversation
Document the GET /v2/:account_id/metrics/email endpoint (email-metrics read API) on developer.drip.com — response shape (summary + per-email breakdown), the three current params (start_date, end_date, broadcast_ids), the 20/hr rate limit, and the 10-item emails cap. Nav placed after Campaigns. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TL;DR
Adds public API docs for the email-metrics read endpoint (
GET /v2/:account_id/metrics/email) to developer.drip.com. Companion to the drip monolith GA (drip#31360, which removes themetrics_apifeature flag). Docs-only; no site config or dependency changes.Background
The email-metrics endpoint is being GA'd (flag removal in drip#31360). It has no public doc partial today, so once GA'd it would be an undocumented endpoint. This is the hand-authored Slate partial for it. (developer.drip.com is this repo's Slate site, not spec-driven — so the doc is authored here, not generated from the monolith's OpenAPI YAML.)
Modification
source/includes/rest/_email_metrics.md— response shape (summary+ per-emailemails[]breakdown), the three currently-accepted params (start_date,end_date,broadcast_ids), the 20 req/hr/account rate limit + 429/Retry-After, and the 10-most-recent cap onemails[].source/index.html.md— one line addingrest/email_metricsto the nav list, after Campaigns (it reports on broadcast/campaign performance).Field names, nesting, rounding (rates
.round(4), revenue in cents), and thebroadcast_id-only-for-broadcasts conditionality were verified against the monolith jbuilders and independently re-verified in a non-maker review.sort_by/page/per_pageare intentionally not documented — the controller doesn't accept them yet (tracked separately).Result
An "Email Metrics" section on developer.drip.com documenting the current surface accurately. cURL/shell sample only (no drip client-lib helper confirmed).
How to verify
Build the Slate site and view the Email Metrics section. NB: the local build currently fails on a pre-existing Ruby-3.x toolchain gap (
webrick, thennet/ftpmissing from this Gemfile) — unrelated to this change; the same gap is being addressed by separate uncommitted Gemfile work. Content was verified statically (valid markdown/HTML, JSON example parses, valid nav YAML, same include mechanism as every live partial) and the response shape verified against the jbuilders.Checklist
emails[]10-cap note — is applied)