Skip to main content

Python wrapper for the BeeHiiv API

Project description

beehiiv

Python wrapper for BeeHiiv API

Install

pip3 install beehiiv

Example

import os
import beehiiv

PUBLICATION_ID = os.environ['BEEHIIV_PUBLICATION_ID']
API_KEY = os.environ['BEEHIIV_API_KEY']

bh = beehiiv.BeeHiiv(api_key=API_KEY, publicationId=PUBLICATION_ID)
subscriptions = bh.subscriptions.index(
  expand=["stats", "custom_fields"],
  limit=5
)
print(subscriptions)

Classes and methods

BeeHiiv.email_blast.index - Retrieve all Email Blasts
BeeHiiv.email_blast.show - Retrieve an Email Blast

BeeHiiv.posts.index - Retrieve all posts belonging to a specific publication
BeeHiiv.posts.show - Retreive a single Post belonging to a specific publication
BeeHiiv.posts.destory - Delete or Archive a post.

BeeHiiv.publications.index - Retrieve all publications associated with your API key.
BeeHiiv.publications.show - Retrieve a single publication

BeeHiiv.referral_program.show - Retrieve details about the publication's referral program

BeeHiiv.segments.index - Retrieve information about all segments belonging to a specific publication
BeeHiiv.segments.show - Retrieve a single segment belonging to a specific publication
BeeHiiv.segments.delete - Delete a segment.
BeeHiiv.segments.expand_results - List the Subscriber Ids from the most recent calculation of a specific publication.

BeeHiiv.subscriptions.create - Create new subscriptions for a publication.  
BeeHiiv.subscriptions.index - Retrieve all subscriptions belonging to a specific publication
BeeHiiv.subscriptions.show - Retrieve a single subscription belonging to a specific publication
BeeHiiv.subscriptions.update - Update a subscriber 
BeeHiiv.subscriptions.delete - Delete a subscription.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

beehiiv-0.2.tar.gz (7.2 kB view details)

Uploaded Source

File details

Details for the file beehiiv-0.2.tar.gz.

File metadata

  • Download URL: beehiiv-0.2.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for beehiiv-0.2.tar.gz
Algorithm Hash digest
SHA256 f69574d0746587bc735e03451cc59127daca35d2b6fa4931333964f1fccf9b8c
MD5 4f1f01ac641628b763262b4a8f2ecf51
BLAKE2b-256 d3cd6073fc3fbde040e30d87c7da962175d4946a6a27014ec63bd98f232eb04a

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page