beehiiv Developer Documentation

Retrieve aggregate stats for all posts

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"

The prefixed ID of the publication object

Query parameters

audienceenumOptionalDefaults to all

Optionally filter the results by audience

Allowed values:

platformenumOptionalDefaults 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:

statusenumOptionalDefaults 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:

content_tags[]list of stringsOptional

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.

hidden_from_feedenumOptionalDefaults 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:

Response

dataobject

1	import requests
2
3	url = "https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/posts/aggregate_stats"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

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	"click_rate": 8,
13	"unsubscribes": 1,
14	"spam_reports": 1
15	},
16	"web": {
17	"views": 200,
18	"clicks": 40
19	},
20	"clicks": [
21	{
22	"url": "https://www.google.com",
23	"email": {
24	"clicks": 10,
25	"unique_clicks": 8,
26	"click_through_rate": 80
27	},
28	"web": {
29	"clicks": 40,
30	"unique_clicks": 40,
31	"click_through_rate": 20
32	},
33	"total_clicks": 50,
34	"total_unique_clicks": 48,
35	"total_click_through_rate": 40
36	}
37	]
38	}
39	}
40	}

Get aggregate stats

Authentication

Path parameters

Query parameters

Response

Errors