Get segment

GET

Retrieve information about a specific segment belonging to a publication

Path parameters

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

The prefixed ID of the publication object

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

The prefixed ID of the segment object

Query parameters

expand[]list of "stats"Optional

Optionally expand the response to include additional data.
stats - Requests the most recently calculated statistics for a segment.
Segment stats are recalculated once daily around 7 a.m. UTC for dynamic segments, but can be manually recalculated at any time in the dashboard. Manual and static segments only calculate once upon upload or creation.

Allowed values: stats

Response

dataobject

The segment object. To expand results, see the results endpoint.

Errors

GET

1 curl https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/segments/seg_00000000-0000-0000-0000-000000000000 \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "data": {
3     "id": "seg_00000000-0000-0000-0000-000000000000",
4     "name": "My Segment",
5     "type": "dynamic",
6     "total_results": 15,
7     "status": "completed",
8     "active": true,
9     "last_calculated": 1666800076,
10     "stats": {
11       "open_rate": 0.5,
12       "total_sent": 100,
13       "percentage_premium_subscribers": 0.2,
14       "percentage_subscribers_with_referrals": 0.1,
15       "unique_emails_clicked": 10,
16       "total_delivered": 100,
17       "total_referrals": 10,
18       "unsubscribed_rate": 0.05,
19       "total_subscribers": 100,
20       "clickthrough_rate": 0.5,
21       "unsubscribed_count": 5,
22       "unique_emails_opened": 10,
23       "premium_subscribers": 20,
24       "average_referrals_per_subscriber": 0.1
25     }
26   }
27 }

Built with

1	curl https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/segments/seg_00000000-0000-0000-0000-000000000000 \
2	-H "Authorization: Bearer <token>"

1	{
2	"data": {
3	"id": "seg_00000000-0000-0000-0000-000000000000",
4	"name": "My Segment",
5	"type": "dynamic",
6	"total_results": 15,
7	"status": "completed",
8	"active": true,
9	"last_calculated": 1666800076,
10	"stats": {
11	"open_rate": 0.5,
12	"total_sent": 100,
13	"percentage_premium_subscribers": 0.2,
14	"percentage_subscribers_with_referrals": 0.1,
15	"unique_emails_clicked": 10,
16	"total_delivered": 100,
17	"total_referrals": 10,
18	"unsubscribed_rate": 0.05,
19	"total_subscribers": 100,
20	"clickthrough_rate": 0.5,
21	"unsubscribed_count": 5,
22	"unique_emails_opened": 10,
23	"premium_subscribers": 20,
24	"average_referrals_per_subscriber": 0.1
25	}
26	}
27	}