diff --git a/USAGE.md b/USAGE.md index bdd4dccfc..96c6ac08b 100644 --- a/USAGE.md +++ b/USAGE.md @@ -22,6 +22,7 @@ sg = sendgrid.SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY')) * [CLIENTS](#clients) * [CONTACTDB](#contactdb) * [DEVICES](#devices) +* [EMAIL ACTIVITY](#email-activity) * [GEO](#geo) * [IPS](#ips) * [MAIL](#mail) @@ -1755,6 +1756,21 @@ print response.status_code print response.body print response.headers ``` + + +# EMAIL ACTIVITY + +## Getting Started With the Email Activity Feed API + +**This endpoint allows you to query your messages.** + + +Email Activity Feed allows you to search and download a CSV of your recent email event activity. For more information on how to get started, please see our [Getting Started Guide](https://sendgrid.com/docs/API_Reference/Web_API_v3/Tutorials/getting_started_email_activity_api.html). + + + + + # GEO diff --git a/examples/messages/messages.py b/examples/messages/messages.py new file mode 100644 index 000000000..1a53c569a --- /dev/null +++ b/examples/messages/messages.py @@ -0,0 +1,8 @@ +import sendgrid +import json +import os + + +sg = sendgrid.SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY')) + +#insert code here diff --git a/use_cases/README.md b/use_cases/README.md index f3aa7e361..3de15d0fd 100644 --- a/use_cases/README.md +++ b/use_cases/README.md @@ -11,6 +11,9 @@ This directory provides examples for specific use cases of this library. Please * [How to Deploy a simple Flask app, to send Email with SendGrid, on Heroku](flask_heroku.md) * [How to Setup a Domain Authentication](domain_authentication.md) * [How to View Email Statistics](email_stats.md) +* [How to Use the Email Activity Feed](email_activity.md) + + ### Working with Mail * [Asynchronous Mail Send](asynchronous_mail_send.md) diff --git a/use_cases/email_activity.md b/use_cases/email_activity.md new file mode 100644 index 000000000..cd3e5cedd --- /dev/null +++ b/use_cases/email_activity.md @@ -0,0 +1,5 @@ +# Email Activity API + +In order to gain access to the Email Activity Feed API, you must [purchase](https://app.sendgrid.com/settings/billing/addons/email_activity) additional email activity history. + +To learn about Sendgrid's API to download information from the Email Activity feed, get started [here.](https://sendgrid.com/docs/API_Reference/Web_API_v3/Tutorials/getting_started_email_activity_api.html)