Meta tags:
description= Retrieve aggregate stats for all posts;
Headings (most frequently used words):
get, oauth, scope, posts, read, parameters, aggregate, stats, authentication, path, query, response, errors, post,
Text of the page (most frequently used words):
badge (200), intent (100), minimal (100), outlined (100), oauth (90), scope (89), info (87), read (50), list (39), get (37), subscription (37), write (37), posts (36), subscriptions (25), post (23), the (18), update (18), newsletter (17), create (14), warning (14), beta (14), all (12), email (11), publications (10), newsletter_lists (10), results (9), webhooks (9), token (8), tier (8), segments (8), delete (7), tiers (7), custom (7), automations (7), data (6), optionally (6), filter (6), return (6), optional (6), authors (6), for (6), web (6), stats (6), api (6), segment (6), custom_fields (6), automation (6), error (5), not (5), that (5), will (5), status (5), aggregate (5), clicks (5), polls (5), field (5), page (4), allowed (4), values (4), only (4), defaults (4), enum (4), any (4), content_tags (4), bearer (4), https (4), com (4), identify (4), webhook (4), deletion (4), with (3), request (3), does (3), restrict (3), hidden_from_feed (3), author (3), tag (3), confirmed (3), platform (3), published (3), publication (3), publicationid (3), unique_clicks (3), beehiiv (3), 0000 (3), aggregate_stats (3), data_deletion (3), condition (3), complimentary (3), access (3), bulk (3), resumed (3), paused (3), requests (2), object (2), response (2), false (2), true (2), feed (2), adding (2), associated (2), filtering (2), have (2), john (2), doe (2), jane (2), smith (2), either (2), example (2), strings (2), content (2), sales (2), closing (2), archived (2), draft (2), scheduled (2), active (2), both (2), audience (2), parameters (2), authentication (2), authorization (2), click_through_rate (2), unique_verified_clicks (2), verified_clicks (2), www (2), google (2), url (2), 200 (2), 100 (2), curl (2), reference (2), demo (2), start (2), trial (2), login (2), add (2), referral (2), program (2), templates (2), send (2), test (2), poll (2), lists (2), engagements (2), fields (2), condition_sets (2), sets (2), complimentary_access (2), updates (2), journeys (2), advertisement (2), opportunities (2), oauth2 (2), survey (2), deleted (2), code (2), integrations (2), rate (2), limiting (2), pagination (2), key (2), getting (2), started (2), search (2), documentation (2), index (2), level (2), llms (2), txt (2), built, next, previous, yes, was, this, helpful, internal, server, 500, too, many, 429, found, 404, unauthorized, 401, bad, 400, errors, attribute, hidden, from, are, visible, their, name, case, insensitive, been, after, longer, scheduled_at, and, premium, free, query, prefixed, format, pub_, required, string, path, form, where, your, auth, retrieve, upgrades, total_click_through_rate, total_unique_clicks, total_clicks, base_url, views, spam_reports, unsubscribes, click_rate, open_rate, unique_opens, opens, delivered, recipients, retrieved, try, pub_00000000, 000000000000, copy, light, workspace, subscriber, ids, subscribers, recalculate, referral_program, responses, user, set, emails, journey, introspect, revoke, authorize, submitted, added, downgraded, upgraded, created, updated, sent, unsubscribed, subscribed, workspaces, tags, del, patch, users, tokens, authorizations, welcome, ask, agents, available, root, append, markdown, version, developer,
Text of the page (random words):
get aggregate stats oauth scope posts read beehiiv developer documentation for ai agents a documentation index is available at the root level at llms txt append llms txt to any url for a page level index or md for the markdown version of any page search ask ai login start trial get a demo search welcome getting started create an api key pagination rate limiting no code integrations webhooks newsletter list subscription post subscription survey oauth2 authorizations tokens api reference advertisement opportunities authors automation journeys automations bulk subscriptions bulk subscription updates complimentary access condition sets custom fields data deletion engagements newsletter lists newsletter list subscriptions oauth users polls posts post create post badge intent info minimal outlined oauth scope posts write badge patch update post badge intent info minimal outlined oauth scope posts write badge get list posts badge intent info minimal outlined oauth scope posts read badge get get aggregate stats badge intent info minimal outlined oauth scope posts read badge get get post badge intent info minimal outlined oauth scope posts read badge del delete post badge intent info minimal outlined oauth scope posts write badge post send test email badge intent info minimal outlined oauth scope posts badge post templates publications referral program segments subscriptions subscription tags tiers webhooks workspaces getting started create an api key pagination rate limiting no code integrations webhooks newsletter list subscription subscribed badge intent warning minimal outlined beta badge newsletter list subscription unsubscribed badge intent warning minimal outlined beta badge newsletter list subscription paused badge intent warning minimal outlined beta badge newsletter list subscription resumed badge intent warning minimal outlined beta badge post sent post updated post scheduled subscription created subscription confirmed subscription deleted subscription upgraded subscription downgraded subscription paused subscription resumed subscription tier paused subscription tier resumed subscription tier added subscription tier deleted survey response submitted oauth2 authorize create token revoke token introspect token get token info get advertisement opportunities badge intent info minimal outlined oauth scope posts read badge list authors get author add subscription to an automation badge intent info minimal outlined oauth scope automations write badge list automation journeys badge intent info minimal outlined oauth scope automations read badge get automation journey badge intent info minimal outlined oauth scope automations read badge list automations badge intent info minimal outlined oauth scope automations read badge get automation badge intent info minimal outlined oauth scope automations read badge list automation emails bulk create subscription badge intent info minimal outlined oauth scope subscriptions write badge list subscription updates badge intent info minimal outlined oauth scope subscriptions read badge get subscription update badge intent info minimal outlined oauth scope subscriptions read badge update subscriptions badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions status badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions status badge intent info minimal outlined oauth scope subscriptions write badge list complimentary access badge intent info minimal outlined oauth scope complimentary_access read badge get complimentary access badge intent info minimal outlined oauth scope complimentary_access read badge list condition sets badge intent info minimal outlined oauth scope condition_sets read badge get condition set badge intent info minimal outlined oauth scope condition_sets read badge create custom field badge intent info minimal outlined oauth scope custom_fields write badge get custom field badge intent info minimal outlined oauth scope custom_fields read badge list custom fields badge intent info minimal outlined oauth scope custom_fields read badge update custom field badge intent info minimal outlined oauth scope custom_fields write badge update custom field badge intent info minimal outlined oauth scope custom_fields write badge delete custom field badge intent info minimal outlined oauth scope custom_fields write badge create data deletion request badge intent info minimal outlined oauth scope data_deletion write badge get data deletion request badge intent info minimal outlined oauth scope data_deletion read badge list data deletion requests badge intent info minimal outlined oauth scope data_deletion read badge get publication engagements badge intent info minimal outlined oauth scope publications read badge list newsletter lists badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge get newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge create newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge update newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge delete newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge create newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge list newsletter list subscriptions badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge get newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge update newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge update newsletter list subscription by subscription id badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge identify user badge intent info minimal outlined oauth scope identify read badge list polls badge intent info minimal outlined oauth scope polls read badge get poll badge intent info minimal outlined oauth scope polls read badge list poll responses badge intent info minimal outlined oauth scope polls read badge create post badge intent info minimal outlined oauth scope posts write badge update post badge intent info minimal outlined oauth scope posts write badge list posts badge intent info minimal outlined oauth scope posts read badge get aggregate stats badge intent info minimal outlined oauth scope posts read badge get post badge intent info minimal outlined oauth scope posts read badge delete post badge intent info minimal outlined oauth scope posts write badge send test email badge intent info minimal outlined oauth scope posts badge get post templates badge intent info minimal outlined oauth scope posts read badge list publications badge intent info minimal outlined oauth scope publications read badge get publication badge intent info minimal outlined oauth scope publications read badge get referral program badge intent info minimal outlined oauth scope referral_program read badge create segment list segments badge intent info minimal outlined oauth scope segments read badge get segment badge intent info minimal outlined oauth scope segments read badge recalculate segment badge intent info minimal outlined oauth scope segments write badge list segment subscribers badge intent info minimal outlined oauth scope segments read badge list segment subscriber ids badge intent info minimal outlined oauth scope segments read badge delete segment badge intent info minimal outlined oauth scope segments write badge create subscription badge intent info minimal outlined oauth scope subscriptions write badge list subscriptions badge intent info minimal outlined oauth scope subscriptions read badge get subscription by email badge intent info minimal outlined oauth scope subscriptions read badge get subscription by id badge intent info minimal outlined oauth scope subscriptions read badge update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge update subscription by email badge intent info minimal outlined oauth scope subscriptions write badge delete subscription badge intent info minimal outlined oauth scope subscriptions write badge add subscription tag badge intent info minimal outlined oauth scope subscriptions write badge create a tier badge intent info minimal outlined oauth scope tiers write badge list tiers badge intent info minimal outlined oauth scope tiers read badge get tier badge intent info minimal outlined oauth scope tiers read badge update a tier badge intent info minimal outlined oauth scope tiers write badge update a tier badge intent info minimal outlined oauth scope tiers write badge create a webhook badge intent info minimal outlined oauth scope webhooks write badge list webhooks badge intent info minimal outlined oauth scope webhooks read badge get webhook badge intent info minimal outlined oauth scope webhooks read badge update webhook badge intent info minimal outlined oauth scope webhooks write badge delete a webhook badge intent info minimal outlined oauth scope webhooks write badge identify workspace badge intent info minimal outlined oauth scope identify read badge get publications by subscription email badge intent info minimal outlined oauth scope publications read badge login start trial get a demo light api reference posts get aggregate stats oauth scope posts read copy page get https api beehiiv com v2 publications publicationid posts aggregate_stats get v2 publications publicationid posts aggregate_stats curl curl https api beehiiv com v2 publications pub_00000000 0000 0000 0000 000000000000 posts aggregate_stats h authorization bearer token try it 200 retrieved 1 2 data 3 stats 4 email 5 recipients 100 6 delivered 100 7 opens 50 8 unique_opens 45 9 open_rate 45 10 clicks 10 11 unique_clicks 8 12 verified_clicks 9 13 unique_verified_clicks 7 14 click_rate 8 15 unsubscribes 1 16 spam_reports 1 17 18 web 19 views 200 20 clicks 40 21 22 clicks 23 24 url https www google com 25 base_url https www google com 26 email 27 clicks 10 28 unique_clicks 8 29 verified_clicks 9 30 unique_verified_clicks 7 31 click_through_rate 80 32 33 web 34 clicks 40 35 unique_clicks 40 36 click_through_rate 20 37 38 total_clicks 50 39 total_unique_clicks 48 40 total_click_through_rate 40 41 42 43 upgrades 5 44 45 46 retrieve aggregate stats for all posts authentication authorization bearer bearer authentication of the form bearer token where token is your auth token path parameters publicationid string required format pub_ 0 9a fa f the prefixed id of the publication object query parameters audience enum optional defaults to all optionally filter the results by audience allowed values free premium all platform enum optional defaults to all optionally filter the results by platform web posts only published to web email posts only published to email both posts published to email and web all does not restrict results by platform allowed values web email both all status enum optional defaults to all optionally filter the results by the status of the post draft not been scheduled confirmed the post will be active after the scheduled_at archived the post is no longer active all does not restrict results by status allowed values draft confirmed archived all content_tags list of strings optional optionally filter posts by content_tags adding a content tag will return any post with that content tag associated to it example filtering for content_tags sales closing will return results of posts that have either sales or closing content_tags authors list of strings optional optionally filter posts by their authors adding an author name will return any post with that author associated to it case insensitive example filtering for authors john doe jane smith will return results of posts that have either john doe or jane smith as authors hidden_from_feed enum optional defaults to all optionally filter the results by the hidden_from_feed attribute of the post all does not restrict results by hidden_from_feed true only return posts hidden from the feed false only return posts that are visible on the feed allowed values all true false response ok data object errors 400 bad request error 401 unauthorized error 404 not found error 429 too many requests error 500 internal server error was this page helpful yes no previous get post oauth scope posts read next built with
|