-
Notifications
You must be signed in to change notification settings - Fork 0
SendGrid plugin #22
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.
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
Open
richbenwell
wants to merge
5
commits into
main
Choose a base branch
from
work/rb/sendgrid
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
SendGrid plugin #22
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| ## Overview | ||
|
|
||
| A plugin for Twilio SendGrid, a popular SMTP server. | ||
|
|
||
| The plugin provides email send stats and unsubscribes, allowing software and marketing teams to report on email performance. | ||
|
|
||
| ## Setup | ||
|
|
||
| Authentication is via API key. | ||
|
|
||
| Create an API key in https://app.sendgrid.com/settings/api_keys | ||
|
|
||
| Select 'Custom Access' and configure the following permissions: | ||
| - Stats (read-only) | ||
| - Suppressions (read-only) | ||
|
|
||
| ## Known limitations | ||
|
|
||
| Account credits cannot be monitored using this plugin. Although an API endpoint is available, it seems to require an API key with full admin access. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| { | ||
| "name": "allClientStats", | ||
| "displayName": "All Client Stats", | ||
| "baseDataSourceName": "httpRequestUnscoped", | ||
| "config": { | ||
| "httpMethod": "get", | ||
| "paging": { | ||
| "mode": "none" | ||
| }, | ||
| "expandInnerObjects": true, | ||
| "endpointPath": "/clients/stats", | ||
| "getArgs": [ | ||
| { | ||
| "key": "start_date", | ||
| "value": "{{timeframe.start.substring(0,10)}}" | ||
| }, | ||
| { | ||
| "key": "aggregated_by", | ||
| "value": "day" | ||
| }, | ||
| { | ||
| "key": "limit", | ||
| "value": "100" | ||
| }, | ||
| { | ||
| "key": "end_date", | ||
| "value": "{{timeframe.end.substring(0,10)}}" | ||
| } | ||
| ], | ||
| "postRequestScript": "script1-post.js", | ||
| "headers": [] | ||
| }, | ||
| "metadata": [ | ||
| { | ||
| "shape": [ | ||
| "date", | ||
| { | ||
| "timeZone": "Etc/UTC" | ||
| } | ||
| ], | ||
| "name": "date" | ||
| }, | ||
| { | ||
| "shape": [ | ||
| "number", | ||
| { | ||
| "decimalPlaces": 0 | ||
| } | ||
| ], | ||
| "name": "metrics.opens" | ||
| }, | ||
| { | ||
| "shape": [ | ||
| "number", | ||
| { | ||
| "decimalPlaces": 0 | ||
| } | ||
| ], | ||
| "name": "metrics.unique_opens" | ||
| }, | ||
| { | ||
| "pattern": ".*" | ||
| } | ||
| ], | ||
| "timeframes": true | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| { | ||
| "name": "blocks", | ||
| "displayName": "Blocks", | ||
| "baseDataSourceName": "httpRequestUnscoped", | ||
| "config": { | ||
| "httpMethod": "get", | ||
| "paging": { | ||
| "mode": "none" | ||
| }, | ||
| "expandInnerObjects": true, | ||
| "endpointPath": "/suppression/blocks", | ||
| "getArgs": [ | ||
| { | ||
| "key": "start_time", | ||
| "value": "{{timeframe.unixStart}}" | ||
| }, | ||
| { | ||
| "key": "end_time", | ||
| "value": "{{timeframe.unixEnd}}" | ||
| }, | ||
| { | ||
| "key": "limit", | ||
| "value": "500" | ||
| } | ||
| ], | ||
| "pathToData": "", | ||
| "headers": [] | ||
| }, | ||
| "metadata": [ | ||
| { | ||
| "shape": [ | ||
| "date", | ||
| { | ||
| "timeZone": "Etc/UTC" | ||
| } | ||
| ], | ||
| "name": "created" | ||
| }, | ||
| { | ||
| "pattern": ".*" | ||
| } | ||
| ], | ||
| "timeframes": true | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| { | ||
| "name": "bounces", | ||
| "displayName": "Bounces", | ||
| "baseDataSourceName": "httpRequestUnscoped", | ||
| "config": { | ||
| "httpMethod": "get", | ||
| "paging": { | ||
| "mode": "none" | ||
| }, | ||
| "expandInnerObjects": true, | ||
| "endpointPath": "/suppression/bounces", | ||
| "getArgs": [ | ||
| { | ||
| "key": "start_time", | ||
| "value": "{{timeframe.unixStart}}" | ||
| }, | ||
| { | ||
| "key": "end_time", | ||
| "value": "{{timeframe.unixEnd}}" | ||
| }, | ||
| { | ||
| "key": "limit", | ||
| "value": "500" | ||
| } | ||
| ], | ||
| "pathToData": "", | ||
| "headers": [] | ||
| }, | ||
| "metadata": [ | ||
| { | ||
| "shape": [ | ||
| "date", | ||
| { | ||
| "timeZone": "Etc/UTC" | ||
| } | ||
| ], | ||
| "name": "created" | ||
| }, | ||
| { | ||
| "pattern": ".*" | ||
| } | ||
| ], | ||
| "timeframes": true | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| { | ||
| "name": "browserStats", | ||
| "displayName": "Browser Stats", | ||
| "baseDataSourceName": "httpRequestUnscoped", | ||
| "config": { | ||
| "httpMethod": "get", | ||
| "paging": { | ||
| "mode": "none" | ||
| }, | ||
| "expandInnerObjects": true, | ||
| "endpointPath": "/browsers/stats", | ||
| "getArgs": [ | ||
| { | ||
| "key": "start_date", | ||
| "value": "{{timeframe.start.substring(0,10)}}" | ||
| }, | ||
| { | ||
| "key": "end_date", | ||
| "value": "{{timeframe.end.substring(0,10)}}" | ||
| }, | ||
| { | ||
| "key": "aggregated_by", | ||
| "value": "{{aggregated_by}}" | ||
| }, | ||
| { | ||
| "key": "limit", | ||
| "value": "1000" | ||
| } | ||
| ], | ||
| "postRequestScript": "script1-post.js", | ||
| "headers": [] | ||
| }, | ||
| "ui": [ | ||
| { | ||
| "name": "aggregated_by", | ||
| "type": "autocomplete", | ||
| "label": "Aggregate by", | ||
| "validation": { | ||
| "required": true | ||
| }, | ||
| "allowCustomValues": false, | ||
| "isMulti": false, | ||
| "defaultValue": "day", | ||
| "data": { | ||
| "source": "fixed", | ||
| "values": [ | ||
| { | ||
| "value": "day", | ||
| "label": "Day" | ||
| }, | ||
| { | ||
| "value": "week", | ||
| "label": "Week" | ||
| }, | ||
| { | ||
| "value": "month", | ||
| "label": "Month" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ], | ||
| "metadata": [ | ||
| { | ||
| "shape": [ | ||
| "date", | ||
| { | ||
| "timeZone": "Etc/UTC" | ||
| } | ||
| ], | ||
| "name": "date" | ||
| }, | ||
| { | ||
| "shape": [ | ||
| "number", | ||
| { | ||
| "decimalPlaces": 0 | ||
| } | ||
| ], | ||
| "name": "metrics.clicks" | ||
| }, | ||
| { | ||
| "shape": [ | ||
| "number", | ||
| { | ||
| "decimalPlaces": 0 | ||
| } | ||
| ], | ||
| "name": "metrics.unique_clicks" | ||
| }, | ||
| { | ||
| "pattern": ".*" | ||
| } | ||
| ], | ||
| "timeframes": true | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| { | ||
| "name": "clientTypeStats", | ||
| "displayName": "Client Type Stats", | ||
| "baseDataSourceName": "httpRequestUnscoped", | ||
| "config": { | ||
| "httpMethod": "get", | ||
| "paging": { | ||
| "mode": "none" | ||
| }, | ||
| "expandInnerObjects": true, | ||
| "endpointPath": "/clients/desktop/stats", | ||
| "getArgs": [ | ||
| { | ||
| "key": "start_date", | ||
| "value": "{{timeframe.start.substring(0,10)}}" | ||
| }, | ||
| { | ||
| "key": "end_date", | ||
| "value": "{{timeframe.end.substring(0,10)}}" | ||
| }, | ||
| { | ||
| "key": "aggregated_by", | ||
| "value": "{{aggregated_by}}" | ||
| }, | ||
| { | ||
| "key": "limit", | ||
| "value": "1000" | ||
| } | ||
| ], | ||
| "postRequestScript": "script1-post.js", | ||
| "headers": [] | ||
| }, | ||
| "ui": [ | ||
| { | ||
| "name": "aggregated_by", | ||
| "type": "autocomplete", | ||
| "label": "Aggregate by", | ||
| "validation": { | ||
| "required": true | ||
| }, | ||
| "allowCustomValues": false, | ||
| "isMulti": false, | ||
| "defaultValue": "day", | ||
| "data": { | ||
| "source": "fixed", | ||
| "values": [ | ||
| { | ||
| "value": "day", | ||
| "label": "Day" | ||
| }, | ||
| { | ||
| "value": "week", | ||
| "label": "Week" | ||
| }, | ||
| { | ||
| "value": "month", | ||
| "label": "Month" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ], | ||
| "metadata": [ | ||
| { | ||
| "shape": [ | ||
| "date", | ||
| { | ||
| "timeZone": "Etc/UTC" | ||
| } | ||
| ], | ||
| "name": "date" | ||
| }, | ||
| { | ||
| "shape": [ | ||
| "number", | ||
| { | ||
| "decimalPlaces": 0 | ||
| } | ||
| ], | ||
| "name": "metrics.opens" | ||
| }, | ||
| { | ||
| "shape": [ | ||
| "number", | ||
| { | ||
| "decimalPlaces": 0 | ||
| } | ||
| ], | ||
| "name": "metrics.unique_opens" | ||
| }, | ||
| { | ||
| "pattern": ".*" | ||
| } | ||
| ], | ||
| "timeframes": true | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because you're only passing in the date part of the timeframe start/end, it might be worth restricting the timeframes here to exclude last 1 hour and last 12 hours? e.g.