Query: Get Campaigns

Mailchimp Operation

The Get Campaigns query enables users to retrieve a list of campaigns in Mailchimp.

Example User Story

As a marketer, I want to retrieve a list of campaigns from Mailchimp so that I can analyze their performance.

Fields

Field Name	Field Type	Required
count	Integer	No
offset	Integer	No
fields	String	No
exclude_fields	String	No

Related Connections

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "get-campaigns",
  "state": "inDev",
  "meta": {
    "short": "Get Campaigns",
    "description": "Retrieve a list of campaigns from Mailchimp."
  },
  "input": [
    {
      "name": "count",
      "type": "Integer",
      "required": false,
      "meta": {
        "description": "Number of campaigns to return."
      }
    },
    {
      "name": "offset",
      "type": "Integer",
      "required": false,
      "meta": {
        "description": "The number of records from a collection to skip."
      }
    },
    {
      "name": "fields",
      "type": "String",
      "required": false,
      "meta": {
        "description": "A comma-separated list of fields to return."
      }
    },
    {
      "name": "exclude_fields",
      "type": "String",
      "required": false,
      "meta": {
        "description": "A comma-separated list of fields to exclude."
      }
    }
  ],
  "output": [
    {
      "name": "campaigns",
      "type": "Array",
      "selector": ["campaigns"],
      "meta": {
        "description": "List of campaigns."
      }
    },
    {
      "name": "total_items",
      "type": "Integer",
      "selector": ["total_items"],
      "meta": {
        "description": "Total number of campaigns."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "GET",
        "path": "/campaigns",
        "headers": {},
        "queryParams": {
          "count": "{{count}}",
          "offset": "{{offset}}",
          "fields": "{{fields}}",
          "exclude_fields": "{{exclude_fields}}"
        }
      }
    }
  ]
}