CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
telegraf/plugins/inputs/mailchimp
History
Paweł Żak 7c9d5e52b0
chore(linters): Fix findings found by `testifylint`: `go-require` for handlers for `plugins/inputs/[a-m]` (#16076) 		2024-10-28 13:58:03 +01:00
..
README.md docs: Update all readme to pass linter (#12615) 2023-02-09 11:04:41 +01:00
chimp_api.go chore: Fix linter findings for `revive:max-public-structs` in `plugins/inputs/[a-n]*` (#15858) 2024-09-12 15:58:57 -05:00
mailchimp.go chore: Fix linter findings for `revive:max-public-structs` in `plugins/inputs/[a-n]*` (#15858) 2024-09-12 15:58:57 -05:00
mailchimp_test.go chore(linters): Fix findings found by `testifylint`: `go-require` for handlers for `plugins/inputs/[a-m]` (#16076) 2024-10-28 13:58:03 +01:00
sample.conf chore(inputs_m-z): migrate sample configs into separate files (#11133) 2022-05-18 11:31:34 -05:00

README.md

Mailchimp Input Plugin

Pulls campaign reports from the Mailchimp API.

Global configuration options

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 for more details.

Configuration

# Gathers metrics from the /3.0/reports MailChimp API
[[inputs.mailchimp]]
  ## MailChimp API key
  ## get from https://admin.mailchimp.com/account/api/
  api_key = "" # required

  ## 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

  ## Campaign ID to get, if empty gets all campaigns, this option overrides days_old
  # campaign_id = ""

Metrics

  • 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)

Example Output