Skip to content

darrensmith223/InboxTracker

Repository files navigation

Build Status Documentation Status

InboxTracker

Python library for Inbox Tracker

Documentation

Documentation for InboxTracker Python Client

Inbox Tracker API Documentation

Installation

Install from Pypi using pip:

$ pip install inboxtracker

You may need to use pip3 to install.

Authentication

You will need an API key to use the Inbox Tracker API. To get an API key, contact support through the Inbox Tracker app.

Once you have an API key, you can pass it to the InboxTracker class:

    from inboxtracker import InboxTracker
    it = InboxTracker("API_KEY")

How to Use

You can use the underlying Inbox Tracker API with the classes in the inboxtracker module:

  • inboxtracker.campaigns
  • inboxtracker.deliverability
  • inboxtracker.domains
  • inboxtracker.intelliseeds
  • inboxtracker.ping
  • inboxtracker.regions
  • inboxtracker.seeds
  • inboxtracker.spam_trap.available_domains
  • inboxtracker.spam_trap.domain
  • inboxtracker.spam_trap.ip
  • inboxtracker.spam_trap.ping
  • inboxtracker.postmaster_tools.yahoo
  • inboxtracker.postmaster_tools.ping

For example, we can retrieve deliverability data for all of the campaigns from the previous day using the inboxtracker.campaigns class:

    from inboxtracker import InboxTracker

    it = InboxTracker("API_KEY")

    response = it.campaigns.get_campaigns(qd="daysBack:1")
    print(response)

For a complete list of classes and functions, see the Inbox Tracker Python documentation.

Contribute

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the repository on GitHub and make your changes in a branch on your fork
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request.

About

Python library for SparkPost's Inbox Tracker

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages