Get post aggregate stats with the beehiiv API
Returns the statistics added up over the posts of a publication that match the filters: email recipients, deliveries, opens, clicks, rates, unsubscribes and spam reports, web views and clicks, and the most clicked links. For large publications the numbers refresh about once an hour, as computed_at shows.
- Identifier
- beehiiv_get_post_aggregate_stats
The request
POST https://connect.reportei.com/api/tools/beehiiv_get_post_aggregate_stats/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"publicationId": "<publicationId>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| publicationId | string | Yes | Id of the publication, from List publications. |
| status | string | No | Only posts in this status. The default is all.Values: draft, confirmed, archived, all |
| platform | string | No | Only posts published to web, to email or to both. The default is all.Values: web, email, both, all |
| audience | string | No | Only posts for this audience. The default is all.Values: free, premium, all |
| hidden_from_feed | string | No | true only the posts hidden from the web feed, false only the visible ones.Values: all, true, false |
Supported connections
Your customer connects their beehiiv account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/beehiiv_get_post_aggregate_stats. It becomes your agent's tool definition with no conversion.
Other beehiiv tools
- List publicationsGETLists the publications the API key reaches, with id, name and organization_name. expand stats adds active subscriptions, average open and click rates and totals sent. Page with page and limit, up to 100; the response has total_pages.
- List subscriptionsGETLists the subscriptions (subscribers) of a publication, optionally only one email, status or tier. Page with limit, up to 100, and cursor: the response has has_more and next_cursor.
- Get subscriptionGETReturns one subscription with email, status, created, subscription_tier, the utm fields and referral_code.
- Create subscriptionPOSTSubscribes an email to a publication and returns the subscription with its id. With double opt-in on the publication, or double_opt_override on, the person confirms by email before becoming active.
- Update subscriptionPATCHUpdates a subscription. Only the fields sent change. unsubscribe true unsubscribes the person from the publication.
- Create subscription tagPOSTAdds tags to a subscription. A tag that does not exist in the publication yet is created.
- List postsGETLists the posts of a publication with id, title, subtitle, status, publish_date and web_url. expand stats adds the email and web statistics of each post. Page with page and limit, up to 100; the response has total_pages.
- Get postGETReturns one post; expand stats adds its email and web statistics. A post created moments ago can answer 202 while beehiiv builds it, and 404 with POST_CREATION_FAILED when the creation failed.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
