2020-08-12 04:10:41 +08:00
|
|
|
# Mailchimp Input Plugin
|
2019-08-20 08:55:35 +08:00
|
|
|
|
2022-06-09 05:22:56 +08:00
|
|
|
Pulls campaign reports from the [Mailchimp API][1].
|
2019-08-20 08:55:35 +08:00
|
|
|
|
2022-06-09 05:22:56 +08:00
|
|
|
[1]: https://developer.mailchimp.com/
|
2019-08-20 08:55:35 +08:00
|
|
|
|
2022-10-27 03:58:36 +08:00
|
|
|
## Global configuration options <!-- @/docs/includes/plugin_config.md -->
|
|
|
|
|
|
|
|
|
|
In addition to the plugin-specific configuration settings, plugins support
|
|
|
|
|
additional global and plugin configuration settings. These settings are used to
|
|
|
|
|
modify metrics, tags, and field or create aliases and configure ordering, etc.
|
|
|
|
|
See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
|
|
|
|
|
|
2023-01-12 23:55:21 +08:00
|
|
|
[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
|
2022-10-27 03:58:36 +08:00
|
|
|
|
2022-06-09 05:22:56 +08:00
|
|
|
## Configuration
|
2019-08-20 08:55:35 +08:00
|
|
|
|
2022-05-24 21:49:47 +08:00
|
|
|
```toml @sample.conf
|
2022-04-12 05:32:25 +08:00
|
|
|
# Gathers metrics from the /3.0/reports MailChimp API
|
2019-08-20 08:55:35 +08:00
|
|
|
[[inputs.mailchimp]]
|
|
|
|
|
## MailChimp API key
|
|
|
|
|
## get from https://admin.mailchimp.com/account/api/
|
|
|
|
|
api_key = "" # required
|
2022-04-12 05:32:25 +08:00
|
|
|
|
2019-08-20 08:55:35 +08:00
|
|
|
## Reports for campaigns sent more than days_old ago will not be collected.
|
|
|
|
|
## 0 means collect all and is the default value.
|
|
|
|
|
days_old = 0
|
2022-04-12 05:32:25 +08:00
|
|
|
|
2019-08-20 08:55:35 +08:00
|
|
|
## Campaign ID to get, if empty gets all campaigns, this option overrides days_old
|
|
|
|
|
# campaign_id = ""
|
|
|
|
|
```
|
|
|
|
|
|
2021-11-25 03:18:53 +08:00
|
|
|
## Metrics
|
2019-08-20 08:55:35 +08:00
|
|
|
|
|
|
|
|
- mailchimp
|
|
|
|
|
- tags:
|
|
|
|
|
- id
|
|
|
|
|
- campaign_title
|
|
|
|
|
- fields:
|
|
|
|
|
- emails_sent (integer, emails)
|
|
|
|
|
- abuse_reports (integer, reports)
|
|
|
|
|
- unsubscribed (integer, unsubscribes)
|
|
|
|
|
- hard_bounces (integer, emails)
|
|
|
|
|
- soft_bounces (integer, emails)
|
|
|
|
|
- syntax_errors (integer, errors)
|
|
|
|
|
- forwards_count (integer, emails)
|
|
|
|
|
- forwards_opens (integer, emails)
|
|
|
|
|
- opens_total (integer, emails)
|
|
|
|
|
- unique_opens (integer, emails)
|
|
|
|
|
- open_rate (double, percentage)
|
|
|
|
|
- clicks_total (integer, clicks)
|
|
|
|
|
- unique_clicks (integer, clicks)
|
|
|
|
|
- unique_subscriber_clicks (integer, clicks)
|
|
|
|
|
- click_rate (double, percentage)
|
|
|
|
|
- facebook_recipient_likes (integer, likes)
|
|
|
|
|
- facebook_unique_likes (integer, likes)
|
|
|
|
|
- facebook_likes (integer, likes)
|
|
|
|
|
- industry_type (string, type)
|
|
|
|
|
- industry_open_rate (double, percentage)
|
|
|
|
|
- industry_click_rate (double, percentage)
|
|
|
|
|
- industry_bounce_rate (double, percentage)
|
|
|
|
|
- industry_unopen_rate (double, percentage)
|
|
|
|
|
- industry_unsub_rate (double, percentage)
|
|
|
|
|
- industry_abuse_rate (double, percentage)
|
|
|
|
|
- list_stats_sub_rate (double, percentage)
|
|
|
|
|
- list_stats_unsub_rate (double, percentage)
|
|
|
|
|
- list_stats_open_rate (double, percentage)
|
|
|
|
|
- list_stats_click_rate (double, percentage)
|
