Skip to main content

A Simple Drift API Wrapper.

Project description

Open Source Love PyPI version

Drift Python

A Drift API wrapper written in Python.

Getting Started

To get started run pip install drift-python

from drift import Drift
drift = Drift("YOUR ACCESS TOKEN")

Contacts

Read the docs here: Contacts API.

Available Methods

  • drift.contacts.get()

    • contact_id (required)
    • email (optional)
    • limit (optional)
  • drift.contacts.create()

    • **attributes (required)

    Example: drift.contacts.create(email='johndoe@drift.com')

  • drift.contacts.update()

    • contact_id (required)
    • **attributes (required)
  • drift.contacts.delete()

    • contact_id (required)
  • drift.contacts.add_tags()

    • contact_id (required)
    • tags (required)

    Example:

    drift.contacts.add_tags(
      conversation_id=1, 
      tags=[{'name': 'My Tag'}]
    )
    
  • drift.contacts.remove_tag()

    • contact_id (required)
    • tag_name (required)
  • drift.contacts.remove_tags_bulk()

    • contact_id (required)

Conversations

Read the docs here Conversations API

Available Methods

  • drift.conversations.get()

    • conversation_id (required)
  • drift.conversations.list()

    • limit (optional) - defaults to 50
    • next_ (optional)
  • drift.conversations.create_message()

    • conversation_id (required)
    • org_id (required)
    • type (required)
    • body (optional)
    • buttons (optional)
    • edited_message_id (optional)
    • edit_type (optional)

    Example:

    drift.conversations.create_message(
        conversation_id=1,
        org_id=1,
        type='chat'
    )
    
  • drift.conversations.get_messages()

    • conversation_id (required)
    • next_ (optional)
  • drift.conversations.get_attachments()

    • doc_id (required)
  • drift.conversations.get_metrics()

    • query (required)

    Example:

    drift.conversations.get_metrics(
        {
          "metrics": [
            {
              "type": "AVG",
              "property": "numBotMessages"
            }
          ],
          "filters": [
            {
              "property": "createdAt",
              "operation": "BETWEEN",
              "values": ["2018-01-01", "2018-07-31"]
            }
          ]
        }
    )
    
    

Users

Read the docs here Users API

Available Methods

  • drift.users.get()

    • user_id (required)
  • drift.users.list()

  • drift.users.update()

    • user_id (required)
    • **attributes (required)

    Example: drift.users.update(243266, phone='555-555-5555')

Contributors

Support / Feedback / Bugs

For support and feedback, you can find us on Slack!

If you've found a bug, feel free to open up a PR with a fix or submit an issue. Let us know in the dev slack!

Project details


Download files

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

Files for drift-python, version 1.1.1
Filename, size File type Python version Upload date Hashes
Filename, size drift_python-1.1.1-py3-none-any.whl (7.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size drift-python-1.1.1.tar.gz (5.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page