Mailchimp Developer LogoMailchimp Developer Wordmark

Transactional API

  • Allowlists

    Add, list, or delete from your Rejection Allowlist.

    • Exports

      Start an export, or get information on export jobs in progress.

      • IPs

        Request and manage Dedicated IPs for your account, and set up reverse DNS.

        • Inbound

          Manage your inbound domains and routes.

          • Messages

            Send, schedule, or get information on your emails.

            • Metadata

              Manage your custom metadata fields in your account.

              • Rejects

                Add, list, or delete from your Rejection Denylist.

                • Senders

                  Manage or get information about your sending domains.

                  • Subaccounts

                    Manage your subaccounts, including the abilitiy to pause and resume sending.

                    • Tags

                      List, delete, or get information on your Tags and their sending statistics.

                      • Get tag info

                        post

                        /tags/info

                        Return more detailed information about a single tag, including aggregates of recent stats.

                        body parameters

                        • keyrequired
                          string

                          a valid api key

                        • tagrequired
                          string

                          an existing tag name

                        Get tag info

                        const mailchimpClient = require("@mailchimp/mailchimp_transactional")(
                          "YOUR_API_KEY"
                        );
                        
                        const run = async () => {
                          const response = await mailchimpClient.tags.info({ tag: "tag" });
                          console.log(response);
                        };
                        
                        run();
                        
                        

                        Success Response

                        • HTTP Status 200

                          the detailed information on the tag

                          • tag
                            string

                            the actual tag as a string

                          • sent
                            integer

                            the total number of messages sent with this tag

                          • hard_bounces
                            integer

                            the total number of hard bounces by messages with this tag

                          • soft_bounces
                            integer

                            the total number of soft bounces by messages with this tag

                          • rejects
                            integer

                            the total number of rejected messages with this tag

                          • complaints
                            integer

                            the total number of spam complaints received for messages with this tag

                          • unsubs
                            integer

                            the total number of unsubscribe requests received for messages with this tag

                          • opens
                            integer

                            the total number of times messages with this tag have been opened

                          • clicks
                            integer

                            the total number of times tracked URLs in messages with this tag have been clicked

                          • stats
                            object

                            an aggregate summary of the tag's sending stats

                            Show Properties

                        Example response

                        JSON
                        {
                          "tag": "string",
                          "sent": 0,
                          "hard_bounces": 0,
                          "soft_bounces": 0,
                          "rejects": 0,
                          "complaints": 0,
                          "unsubs": 0,
                          "opens": 0,
                          "clicks": 0,
                          "stats": {
                            "today": {
                              "sent": 0,
                              "hard_bounces": 0,
                              "soft_bounces": 0,
                              "rejects": 0,
                              "complaints": 0,
                              "unsubs": 0,
                              "opens": 0,
                              "unique_opens": 0,
                              "clicks": 0,
                              "unique_clicks": 0
                            },
                            "last_7_days": {
                              "sent": 0,
                              "hard_bounces": 0,
                              "soft_bounces": 0,
                              "rejects": 0,
                              "complaints": 0,
                              "unsubs": 0,
                              "opens": 0,
                              "unique_opens": 0,
                              "clicks": 0,
                              "unique_clicks": 0
                            },
                            "last_30_days": {
                              "sent": 0,
                              "hard_bounces": 0,
                              "soft_bounces": 0,
                              "rejects": 0,
                              "complaints": 0,
                              "unsubs": 0,
                              "opens": 0,
                              "unique_opens": 0,
                              "clicks": 0,
                              "unique_clicks": 0
                            },
                            "last_60_days": {
                              "sent": 0,
                              "hard_bounces": 0,
                              "soft_bounces": 0,
                              "rejects": 0,
                              "complaints": 0,
                              "unsubs": 0,
                              "opens": 0,
                              "unique_opens": 0,
                              "clicks": 0,
                              "unique_clicks": 0
                            },
                            "last_90_days": {
                              "sent": 0,
                              "hard_bounces": 0,
                              "soft_bounces": 0,
                              "rejects": 0,
                              "complaints": 0,
                              "unsubs": 0,
                              "opens": 0,
                              "unique_opens": 0,
                              "clicks": 0,
                              "unique_clicks": 0
                            }
                          }
                        }
                      • Templates

                        Manage the Templates in your account.

                        • URLs

                          Manage your tracking domains. Some of these endpoints may be deprecated.

                          • Users

                            Get information about your account, or ping Transactional.

                            • Webhooks

                              Manage the webhooks in your account.

                              • Whitelists

                                Add, list, or delete from your Rejection Allowlist. These endpoints are being replaced with a series of functionally identical endpoints called /allowlists.