Skip to main content
# Drift Python
A [Drift API](https://devdocs.drift.com) wrapper written in Python.


## Getting Started
To get started run `pip install drift-python`

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

## Contacts
Read the docs here: [Contacts API](https://devdocs.drift.com/docs/contact-model).

**Available Methods**

- `drift.contacts.get()`
- contact_id (required)
- email (optional)
- limit (optional)

- `drift.contacts.list()`
- limit (optional) - defaults to `40`
- cursor (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](https://devdocs.drift.com/docs/conversation-overview)

**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)
- 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"]
}
]
}
)

```


## Contributors
- Lemuel Boyce [rhymiz](https://github.com/rhymiz)
- Chris Buonocore [cbonoz](https://github.com/cbonoz)


## Support / Feedback / Bugs
For support and feedback, you can find us on [Slack](https://join.slack.com/t/devdrift/shared_invite/enQtMzg4MTI3NDk5NDQ0LWUwMWYzZTkyMmQ1YjdkNjkwZDg2Mzk2YjAyMDg4MWViYmIzZjVhZTczNDQwMDVjOGRjZGU5OTkxMWQ0ZGU0Mjg)!

If you've found a bug, feel free to open up a PR with a fix or submit an issue.

Download files

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

Source Distribution

drift-python-1.0.0.tar.gz (4.3 kB view details)

Uploaded Source

File details

Details for the file drift-python-1.0.0.tar.gz.

File metadata

  • Download URL: drift-python-1.0.0.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/2.7.15

File hashes

Hashes for drift-python-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a6d2da7bad9db5873f9dca58010235270c48096fcf45f7aaa7c2db6423b4e6ad
MD5 01ec3563d2ccc04d824cc1bf21c57559
BLAKE2b-256 4501aaf659fc1388149fb8230aedc4626a081dfcb3010f7e1d1c5521c3762527

See more details on using hashes here.

Release history Release notifications | RSS feed

1.1.3

1 file

1.1.2

1 file

1.1.1

2 files

1.1.0

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

This release

1.0.0 This release

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page