Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add Email Activity API to usage docs #759

Merged
merged 7 commits into from
Jul 20, 2020
Merged

docs: add Email Activity API to usage docs #759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
292f5c5
Create messages.py
ajloria Oct 26, 2018
74509c0
Update USE_CASES.md
ajloria Oct 26, 2018
663bf24
Update USAGE.md
ajloria Oct 26, 2018
d768afc
Merge branch 'master' into master
Jul 20, 2020
1986f47
Update USE_CASES.md
Jul 20, 2020
9ef598a
Delete messages.py
Jul 20, 2020
b522d99
Update USAGE.md
Jul 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ $sg = new \SendGrid($apiKey);
* [CLIENTS](#clients)
* [CONTACTDB](#contactdb)
* [DEVICES](#devices)
* [EMAIL ACTIVITY](#email-activity)
* [GEO](#geo)
* [IPS](#ips)
* [MAIL](#mail)
Expand Down Expand Up @@ -1824,6 +1825,16 @@ print $response->statusCode() . "\n";
print $response->body() . "\n";
print_r($response->headers());
```

<a name="email-activity"></a>
# 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).

<a name="geo"></a>
# GEO

Expand Down
6 changes: 6 additions & 0 deletions USE_CASES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ This documentation provides examples for specific use cases. Please [open an iss
- [Send an SMS Message](#send-an-sms-message)
- [How to Set up a Domain Authentication](#how-to-set-up-a-domain-authentication)
- [How to View Email Statistics](#how-to-view-email-statistics)
- [How to Use the Email Activity Feed](#how-to-use-the-email-activity-feed-api)
- [Deploying to Heroku](#deploying-to-heroku)
- [Google App Engine Installation](#google-app-engine-installation)

Expand Down Expand Up @@ -1395,6 +1396,11 @@ You can find documentation for how to view your email statistics via the UI [her

Alternatively, we can post events to a URL of your choice via our [Event Webhook](https://example.com/docs/API_Reference/Webhooks/event.html) about events that occur as Twilio SendGrid processes your email.

<a name="email-activity"></a>
# How to Use the Email Activity Feed 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).

<a name="heroku"></a>
# Deploying to Heroku

Expand Down