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

ParameterTypeRequiredDescription
publicationIdstringYesId of the publication, from List publications.
statusstringNoOnly posts in this status. The default is all.Values: draft, confirmed, archived, all
platformstringNoOnly posts published to web, to email or to both. The default is all.Values: web, email, both, all
audiencestringNoOnly posts for this audience. The default is all.Values: free, premium, all
hidden_from_feedstringNotrue 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

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.