Skip to content

Commit

Permalink
[SAASINT-3425] DDSaaS: Mailchimp - README changes (#19076)
Browse files Browse the repository at this point in the history
* updated readme as per the review comments

* Updated Mailchimp readme as per review comments
  • Loading branch information
akaila-crest authored Dec 18, 2024
1 parent fc33628 commit f2a8233
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions mailchimp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,36 +13,35 @@ The Mailchimp integration collects metrics from campaigns and lists, directing t

## Setup

### Configuration
### Generate API credentials in Mailchimp

#### Get API credentials for Mailchimp
1. Log in to your [Mailchimp account][2].
2. Check the url for the Server prefix. It is the `xxxx`part of the url(eg: `https://xxxx.admin.mailchimp.com/`).
3. Click on the profile icon and select Profile option.
4. Navigate to the **Extras** tab and click on **API keys** from the Dropdown.
5. Scroll down to the **Your API Keys** section and click **Create A Key**.
6. Enter your preferred name for the API key and click on **Generate Key**. Your API key is now generated.

1. Log in to your [Mailchimp account][2] and click the profile icon
2. Navigate to the **Extras** tab
3. Click **API keys**
4. Scroll down to the **Your API Keys** section and click **Create A Key**
5. Enter your preferred name for the API key and click **Ok**
6. Once the API key is generated, copy and save it as you will only see it once

### Connect your Mailchimp Account to Datadog

#### Mailchimp DataDog integration configuration
1. Add your Marketing API Key and Server Prefix
|Parameters|Description|
|--------------------|--------------------|
|Marketing API key|API key for your Mailchimp marketing account.|
|Server prefix|Server prefix (for example: us13) of the Mailchimp account.|

Configure the Datadog endpoint to forward Mailchimp metrics to Datadog.
2. Click the Save button to save your settings.

1. Navigate to the `Mailchimp` integration tile in Datadog.
2. Add your Mailchimp credentials.

| Mailchimp parameters | Description |
| -------------------- | ------------ |
| Marketing API key | API key for your Mailchimp marketing account. |
| Server prefix | Server prefix (for example: us13) of the Mailchimp account. It is the `xxxx` part of `https://xxxx.admin.mailchimp.com/`. |

## Data Collected

### Metrics

The Mailchimp integration collects and forwards campaign and list (audience) metrics to Datadog.

{{< get-metrics-from-git "mailchimp" >}}

### Service Checks

The Mailchimp integration does not include any service checks.
Expand Down

0 comments on commit f2a8233

Please sign in to comment.